Skip to content

Adding Asciidoc map preview script and left TOC JS file#114783

Open
bscott-rh wants to merge 1 commit into
openshift:mainfrom
bscott-rh:preview-maps-script
Open

Adding Asciidoc map preview script and left TOC JS file#114783
bscott-rh wants to merge 1 commit into
openshift:mainfrom
bscott-rh:preview-maps-script

Conversation

@bscott-rh

@bscott-rh bscott-rh commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

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:

  • writer has enabled GitHub Pages in their fork of the openshift-docs repo
  • writer has a gh-pages branch in their fork (should be created automatically by the prior step)
  • writer has configured their fork's Pages settings to build from the gh-pages branch (this is the default setting)
  • writer has some JTBD maps in the maps/ directory, with corresponding assemblies and modules in the assemblies/ and modules/ directories respectively

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-pages branch in a separate worktree in /tmp, uses asciidoctor to build the maps/navigation.adoc file, and pushes the resulting HTML into the gh-pages branch, 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.html
and 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

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 7, 2026
@bscott-rh bscott-rh added the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Jul 7, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown

🤖 Tue Jul 07 17:55:21 - Prow CI generated the docs preview:

https://114783--ocpdocs-pr.netlify.app/

@openshift-ci

openshift-ci Bot commented Jul 7, 2026

Copy link
Copy Markdown

@bscott-rh: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants