Sync master/root README.md and provide a script to do this #831
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #831 +/- ##
=======================================
Coverage 44.68% 44.68%
=======================================
Files 75 75
Lines 4565 4565
=======================================
Hits 2040 2040
Misses 2392 2392
Partials 133 133Continue to review full report at Codecov.
|
zubron
approved these changes
Aug 12, 2019
scripts/sync_readme.sh
Outdated
| SCRIPTS_DIR="$( cd "$( dirname "$0" )" >/dev/null 2>&1 && pwd )" | ||
| DIR=$(cd $SCRIPTS_DIR; cd ..; pwd) | ||
| ROOT_README=$DIR/README.md | ||
| MASTER_SITE_README=./site/docs/master/README.md |
There was a problem hiding this comment.
This should be $DIR/site/... so that it's independent of where it's being run from.
The README for the master version of the docs and in the root of the repo (used by Github) should always be in sync but require minor changes due to different relative locations of resources and links. Also added this script as part of our CI to ensure that the two files don't drift. Fixes #772 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
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:
The README for the master version of the docs and in the root
of the repo (used by Github) should always be in sync but
require minor changes due to different relative locations of
resources and links.
Also added this script as part of our CI to ensure that the two
files don't drift.
Which issue(s) this PR fixes
Fixes #772
Special notes for your reviewer:
Also found that there was drift; the master docs had a link to the page about
waitfunctionality, but the root readme did not. The link wasn't actually used/needed so I removed it.Release note: