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

Links in new docs script #892

Merged
merged 1 commit into from
Sep 18, 2019
Merged

Links in new docs script #892

merged 1 commit into from
Sep 18, 2019

Conversation

johnSchnake
Copy link
Contributor

What this PR does / why we need it:
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.

Which issue(s) this PR fixes
Fixes #887

Special notes for your reviewer:
To test this, I'd do the following:

  • checkout this branch
  • run the script to generate the 'new' docs for a phony version: ./scripts/update_docs.sh v0.15.999
  • commit the change locally (so we can look at the diff later)
  • add back the line I removed
  • run the same command again ./scripts/update_docs.sh v0.15.999
  • run git diff to look at the difference.

You'll see some redundant things (it adds to the TOC and a few other files, but the script is meant to be just for 'new' versions of the docs).

The main thing to see is that the diff should show just a small change in the links. It used to show full URLs for doc pages but it should now be showing relative URLs/paths.

NOTE
I'm going to add a second commit showing what the 'new' docs look like. When approved I'll remove that commit before merging.

Release note:

NONE

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]>
@johnSchnake johnSchnake requested a review from zubron September 18, 2019 15:53
@codecov-io
Copy link

Codecov Report

Merging #892 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #892   +/-   ##
=======================================
  Coverage   47.29%   47.29%           
=======================================
  Files          75       75           
  Lines        5034     5034           
=======================================
  Hits         2381     2381           
  Misses       2515     2515           
  Partials      138      138

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3d6c1be...8a5788c. Read the comment docs.

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 including the instructions on how to check this locally! 👍

@johnSchnake johnSchnake merged commit 0b77329 into vmware-tanzu:master Sep 18, 2019
@johnSchnake johnSchnake deleted the linksInNewDocsScript branch September 18, 2019 18:06
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.

Update tooling for making new versioned docs
3 participants