Adding Asciidoc map preview script and left TOC JS file#114783
Open
bscott-rh wants to merge 1 commit into
Open
Adding Asciidoc map preview script and left TOC JS file#114783bscott-rh wants to merge 1 commit into
bscott-rh wants to merge 1 commit into
Conversation
|
🤖 Tue Jul 07 17:55:21 - Prow CI generated the docs preview: |
|
@bscott-rh: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
This file contains hidden or 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
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.
This PR adds a bash script for building and publishing JTBD maps to GitHub Pages, as well as a javascript file that adds collapsible elements to the left hand nav.
Prerequisites:
gh-pagesbranch in their fork (should be created automatically by the prior step)gh-pagesbranch (this is the default setting)The script is meant to be run from the root of the openshift-docs repo in a feature branch. The script checks out the
gh-pagesbranch in a separate worktree in/tmp, uses asciidoctor to build themaps/navigation.adocfile, and pushes the resulting HTML into thegh-pagesbranch, which triggers GitHub Pages to host the HTML.The script produces two URLs, one being the preview URL for the changes that were just pushed, in the following format:
https://${GH_USERNAME}.github.io/${GH_REPO}/${BRANCH}/navigation.htmland one being the URL to check the status of the Pages deployment in GitHub (to check for errors, or just see when the preview is ready):
https://github.com/${GH_USERNAME}/${GH_REPO}/deployments