Giter Site home page Giter Site logo

Comments (2)

dcdenu4 avatar dcdenu4 commented on July 17, 2024

It doesn't make sense for most users to see the corresponding UG updates until those invest changes are released.

Yep, definitely agree.

We could also use separate main and release branches like we do with invest, but that might be more work than needed to solve the problem.

This is what I thought our current approach was. My understanding is that the benefit of how things are currently set up is that we can fix things in the Users Guide to better reflect the latest released InVEST version or help clarify something for the latest released InVEST version. I think that has proved useful with forum feedback where someone might point out a confusing pain point that we can quickly update.

the python docs do this better IMO. A dropdown menu at the top defaults to the most recent released version, but you can switch to the dev version or older versions.

That is a nice feature. I think the difference we have is updating the UG for the current version of InVEST. I'm not sure what the Python project does if it finds a significant mistake in it's documentation for a current release... Maybe they let it be as is and punt the fix to the next release (dev (X.Y)).

from invest.users-guide.

emlys avatar emlys commented on July 17, 2024

This is what I thought our current approach was.

I think we have done it in the past and I recently made a release/3.10.2 branch. Happy to keep using that strategy. Just want to make sure we're all in agreement about it, since before I think we let some things get merged into main and published early.

from invest.users-guide.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.