Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
./scripts/update_docs.sh v0.15.999
./scripts/update_docs.sh v0.15.999
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: