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 v0.15.0 doc snapshot and automate process #770

Merged
merged 1 commit into from
Jun 24, 2019
Merged

Add v0.15.0 doc snapshot and automate process #770

merged 1 commit into from
Jun 24, 2019

Conversation

johnSchnake
Copy link
Contributor

What this PR does / why we need it:

  • Adds script to automate adding a new version of the docs
  • Removes the now deprecated docs directory
  • Adds docs for v0.15.0 and sets as the newest version of the docs
  • Updates the release doc to reference the script that automates
    the addition of a new docs section

Which issue(s) this PR fixes
No formal issue for this; was related to v0.15.0 release.

Special notes for your reviewer:

Release note:

NONE

@johnSchnake johnSchnake requested a review from zubron June 24, 2019 18:26
@johnSchnake
Copy link
Contributor Author

johnSchnake commented Jun 24, 2019

TODO:

  • New page doesnt seem to use the right toc; simple fix
  • Footer not updated to link to right docs; simple fix

I didn't want to keep adding content changes here but the ones I included were either fixing an inconsistency (having an extraneous docs directory) or related directly to this automation. However, I want a followup to add:

  • We should update part of the readme that links to the docs to link to the doc site instead of the github page. That is the point of the new site to some extent. In addition, I noticed that list is formatted incorrectly and it just runs on in a paragraph instead of actually being a list.

scripts/update_docs.sh Outdated Show resolved Hide resolved
 - Adds script to automate adding a new version of the docs
 - Removes the now deprecated `docs` directory
 - Adds docs for v0.15.0 and sets as the newest version of the docs
 - Updates the release doc to reference the script that automates
the addition of a new docs section

Signed-off-by: John Schnake <[email protected]>
Copy link
Contributor

@zubron zubron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing up the scripts to work on Linux as well! I've tried it out locally with a fake new version and it all looks good 👍

@johnSchnake johnSchnake merged commit 6811a38 into vmware-tanzu:master Jun 24, 2019
@johnSchnake johnSchnake deleted the v0-15-0-docs branch June 24, 2019 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants