docs: add JTBD job-based navigation for cli_reference (openshift-ente…#115857
Open
DonaghBr wants to merge 1 commit into
Open
docs: add JTBD job-based navigation for cli_reference (openshift-ente…#115857DonaghBr wants to merge 1 commit into
DonaghBr wants to merge 1 commit into
Conversation
…rprise) Sample structure generated by jtbd-apply --distro from the CLI-tools top-jobs module map. Adds a job-based ASSEMBLY layout: - maps/openshift-enterprise/: per-distro navigation + flat category maps - assemblies/: job assemblies referencing existing cli_reference modules Co-Authored-By: Claude Opus <noreply@anthropic.com>
openshift-ci
Bot
added
size/L
|
Hi @DonaghBr. Thanks for your PR. I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
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
1 participant
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.
Proof-of-concept showing a Jobs-To-Be-Done (JTBD) job-based navigation for the CLI tools reference, generated by the CCS jtbd tooling. It reorganizes the existing cli_reference content into job-oriented entry points without changing any of the underlying modules.
Pipeline used to produce it:
What this adds (new files only, nothing existing is modified):
Structure: 6 categories (Discover, Get Started, Configure, Integrate, Extend, Reference) across 7 jobs, e.g. "Discover CLI tools", "Install and get started with the OpenShift CLI", "Extend the CLI with plugins".
Not destructive: existing books, assemblies, and modules are untouched; this only adds the new job-based layer. Intended for structure review, not merge.
Preview (local): from the branch, run
cd maps/openshift-enterprise && asciidoctor navigation.adoc -a toc=left
and open navigation.html (self-contained; left TOC = the JTBD hierarchy).