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

Add Versioning to docs site for next release #10

Open
1 task
cmjc opened this issue Jan 25, 2022 · 2 comments
Open
1 task

Add Versioning to docs site for next release #10

cmjc opened this issue Jan 25, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation triage Needs prioritisation and/or scheduling

Comments

@cmjc
Copy link
Collaborator

cmjc commented Jan 25, 2022

As an Autonity docs site user
I want to access versions of documentation for current and previous releases of the Autonity software
So that I can read documentation for the Autonity software version I am using.

Tasks:

  • Add versioning to docs.autonity.org.

References

@cmjc cmjc self-assigned this Jan 25, 2022
@cmjc cmjc transferred this issue from another repository Jan 23, 2023
@aiman
Copy link
Collaborator

aiman commented Apr 20, 2023

It is worth clarifying what version we want to display in the version dropdown. We should keep it simple and use a single version identifier, and I suggest it would be more appropriate to go with the "protocol version" (currently named after rivers).

@cmjc
Copy link
Collaborator Author

cmjc commented Apr 21, 2023

Yes, agree.

We could have as of now, for example:

  • Latest (shows the current stable release docs. At the moment, Thames, driven from master branch`)
  • Develop (shows the development branch, a preview of the next release under dev, driven from develop branch)
  • Protocol Version name - e.g. Thames. The current stable release. At the moment, Thames. Older versions have the previous release name and are ordered by time.

Publishing it, we can publish from docs repo {release | tag} perhaps. This was done for previous docs sites in MK Docs (by @cmjc and @Klazomenai ).

In the Reference, Codebase section (https://docs.autonity.org/reference/codebase/):

In the scenario where a new client version is released but it's the same protocol version (e.g. a minor change, e.g. adding a new command line option):

  • Add bullet point to the release as above on the Reference Codebase page to say Docs updated for new client version XYZ (x.y.z).
  • Highlight in the docs where a change has been made for this new version. For example, create a custom Shortcode or use a Note or a Card

@cmjc cmjc added documentation Improvements or additions to documentation triage Needs prioritisation and/or scheduling labels Jan 2, 2025
@cmjc cmjc removed their assignment Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation triage Needs prioritisation and/or scheduling
Projects
None yet
Development

No branches or pull requests

2 participants