Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More clearly separate changes corresponding to unreleased invest changes #59

Open
emlys opened this issue Jan 8, 2022 · 2 comments
Open
Labels
enhancement New feature or request

Comments

@emlys
Copy link
Member

emlys commented Jan 8, 2022

The user's guide that comes up in google search and that we link to is the latest revision on main. So far we've accepted that the user's guide may be a little out of sync with the latest invest release: we push changes to main and publish them when the corresponding invest PR goes through, but the invest changes aren't available til the next release.

Lately there have been more situations where this might confuse people. For example in natcap/invest#800, 2 inputs were removed and some outputs were introduced. It doesn't make sense for most users to see the corresponding UG updates until those invest changes are released.

Proposed solution: display last release version by default

Continue to push changes to main as usual and make them available as the latest version.
But default to displaying the UG as of the last release version. We do have a version dropdown but it defaults to latest. (Example: 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.)

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.

@emlys emlys added the enhancement New feature or request label Jan 8, 2022
@dcdenu4
Copy link
Member

dcdenu4 commented Jan 11, 2022

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)).

@emlys
Copy link
Member Author

emlys commented Jan 13, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants