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.

Sign up for GitHub

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

Jump to bottom

Version Documentation #2708

Closed
asmacdo opened this issue Mar 23, 2020 · 4 comments
Closed

Version Documentation #2708

asmacdo opened this issue Mar 23, 2020 · 4 comments
Assignees
@jberkhahn
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Milestone
v1.0.0

Comments

@asmacdo
Copy link
Member

asmacdo commented Mar 23, 2020

Versioned Documentation

As a user, I would like to view SDK documentation for the version I am using

This can be accomplished using the docsy "Releases" feature, which adds a Releases dropdown, which can link to arbitrary urls. On release, SDK will need to build a new version (to a new subdomain) and add a link to that version on master.
@asmacdo
Copy link
Member Author

asmacdo commented Mar 24, 2020 •
edited
Loading

See: google/docsy#114 (comment)
https://www.docsy.dev/docs/adding-content/versioning/

@asmacdo asmacdo mentioned this issue Mar 24, 2020
Merged
@asmacdo asmacdo added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 25, 2020
@estroz estroz modified the milestones: v1.0.0, v0.17.0 Mar 30, 2020
@estroz
Copy link
Member

estroz commented Mar 30, 2020

Versioned docs in the website will likely start at the SDK version this is completed in.

@asmacdo asmacdo modified the milestones: v0.17.0, v0.18.0 Apr 13, 2020
@estroz
Copy link
Member

estroz commented May 22, 2020

/priority important-longterm

@openshift-ci-robot openshift-ci-robot added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label May 22, 2020
@estroz estroz modified the milestones: v0.18.0, v1.0.0 May 22, 2020
@estroz
Copy link
Member

estroz commented Jul 24, 2020

@asmacdo I think this is done. If not, please re-open.

@estroz estroz closed this as completed Jul 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jberkhahn jberkhahn

Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
4 participants
@asmacdo @jberkhahn @estroz @openshift-ci-robot