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

Update tooling for making new versioned docs #887

Closed
johnSchnake opened this issue Sep 17, 2019 · 1 comment · Fixed by #892
Closed

Update tooling for making new versioned docs #887

johnSchnake opened this issue Sep 17, 2019 · 1 comment · Fixed by #892
Assignees
@johnSchnake
Labels
area/documentation Related to project documentation legacy/release p2-moderate
Milestone
v0.16.0

Comments

@johnSchnake
Copy link
Contributor

Describe the solution you'd like
When running
./scripts/update_docs.sh

It creates a new set of versioned docs based on the current set for master. However, I think it copies the README from the repo root and so the URLs are not appropriate for the website. They should be using relative links between pages and things like that so links will go to the correct page for that version of the docs.
@johnSchnake johnSchnake self-assigned this Sep 17, 2019
@johnSchnake johnSchnake mentioned this issue Sep 17, 2019
Merged
@johnSchnake
Copy link
Contributor Author

Also update the release docs to link to travis for checking the build/release. For tagged releases there isn't a PR to grab the link from ( https://travis-ci.org/heptio/sonobuoy/builds )

@johnSchnake johnSchnake added this to the v0.16.0 milestone Sep 17, 2019
@johnSchnake johnSchnake mentioned this issue Sep 18, 2019
Merged
johnSchnake added a commit that referenced this issue Sep 18, 2019
@johnSchnake
Fix script to make new versioned docs (#892)
0b77329 
This script was written to consider the root README as the source
of truth but I think that was before we realized that the docs
for the site have slightly different linking requirements.

As a result, the appropriate place to take the README from is the
master docs.

Fixes #887

Signed-off-by: John Schnake <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnSchnake johnSchnake

Labels
area/documentation Related to project documentation legacy/release p2-moderate
Projects
None yet
Milestone
v0.16.0
Development

Successfully merging a pull request may close this issue.

Links in new docs script
1 participant
@johnSchnake