Skip to content

support versioned standards #209

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

Open
alee opened this issue May 3, 2021 · 1 comment
Open

support versioned standards #209

alee opened this issue May 3, 2021 · 1 comment
Labels
OMF site infrastructure cyberinfrastructure for site

Comments

@alee
Copy link
Member

alee commented May 3, 2021

https://discourse.gohugo.io/t/documentation-site-versioning/5898/4

https://stackoverflow.com/questions/47643881/github-pages-maintaining-multiple-versions

https://www.docsy.dev/docs/adding-content/versioning/

Possible strategies:

  1. All standards evolve together with a single semver or datever style version number (e.g., kubeflow / django / readthedocs etc
  2. version standards independently as @cpritcha suggests in each standards subfolder with links to current | stable | dev
  3. any others to consider?

Other considerations include embedding a citation.cff file with each versioned standard that properly credits the authors of the standard #441

@alee alee added the OMF site infrastructure cyberinfrastructure for site label May 3, 2021
@cpritcha
Copy link
Contributor

cpritcha commented May 3, 2021

The way to version mentioned in the docsy dev docs is https://www.docsy.dev/docs/adding-content/versioning/ (this is used for the version dropdown at https://www.kubeflow.org). To keep use from maintaining multiple versions however I think it would be easiest to have subfolders for in each standard folder (accessibility, documentation etc) for our old standard versions. Then we only have to maintain the one. I think we could still setup our site the kubeflow way on gh-pages by rendering old git tags of versions into a special folder but that would still force us to either have same version number across all our standards or split the repository into one standard one repository form.

@alee alee changed the title versioned documentation support versioned standards May 31, 2021
alee added a commit that referenced this issue Dec 16, 2021
resolve versioning issues with #209
alee added a commit that referenced this issue Dec 16, 2021
- charter has been officially adopted
- resolve versioning issues along with #209 

Co-authored-by: Allen Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OMF site infrastructure cyberinfrastructure for site
Projects
Status: Todo
Development

No branches or pull requests

3 participants