Skip to content
New issue

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

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

Already on GitHub? # to your account

Apply versioning to our documentation #1945

Open
evetion opened this issue Nov 21, 2024 · 4 comments
Open

Apply versioning to our documentation #1945

evetion opened this issue Nov 21, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@evetion
Copy link
Member

evetion commented Nov 21, 2024

As we now have things documented (such as Delwaq coupling functionality) that is not released yet (found by a user during DSD).

In documentation we will add from which version functionality available is. Should be part of our review proces.

@evetion evetion added this to Ribasim Nov 21, 2024
@evetion evetion converted this from a draft issue Nov 21, 2024
@evetion evetion removed the status in Ribasim Nov 21, 2024
@evetion evetion added documentation Improvements or additions to documentation enhancement labels Nov 21, 2024
@evetion
Copy link
Member Author

evetion commented Nov 25, 2024

Unlikely to be done in Quarto itself: quarto-dev/quarto-cli#474. They advise not versioning documentation (but writing a single clear documentation).

@visr
Copy link
Member

visr commented Nov 25, 2024

We could start using callout notes to hint users from which version certain features are available, especially for unreleased features. And we should fix #666 so we always have frozen PDFs as a backup.

@visr visr removed the enhancement label Nov 26, 2024
@visr
Copy link
Member

visr commented Dec 5, 2024

@JoostBuitink added a version switcher seemingly based on the Documenter version switching code to Wflow in Deltares/Wflow.jl@8605bf1#diff-bf446527f10d7498864186e82612d5a93f7d2b63148550644c6cdf2bfbeab4b6.

See e.g. https://github.com/Deltares/Wflow.jl/blob/06b1b2b935fb2612535522d9fccabe2c5be8eec9/docs/_static/version.js and https://deltares.github.io/Wflow.jl/dev/.

Image

In the https://github.com/Deltares/Wflow.jl/tree/gh-pages branch then each version gets its own folder.

Although I am warming up to the Quarto recommendation not to version documentation as well.

@JoostBuitink
Copy link

I'll pass the credit where credit is due ;) I have based this upon the work done by @dalmijn for the Delft-FIAT docs (https://github.com/Deltares/Delft-FIAT). This is basically a slighly simplified version of his version-switcher. I get the arguments made by the quarto devs, but still believe it is very valuable to have versions of the documentation connected to specific releases.

@SnippenE SnippenE moved this to To do in Ribasim Dec 9, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: To do
Development

No branches or pull requests

3 participants