Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for content snippets within quick start tasks #224

Open
jbyrne-redhat opened this issue Feb 1, 2023 · 0 comments
Open

Add support for content snippets within quick start tasks #224

jbyrne-redhat opened this issue Feb 1, 2023 · 0 comments

Comments

@jbyrne-redhat
Copy link

jbyrne-redhat commented Feb 1, 2023

WHAT
Add support for content snippets within quick start tasks.

WHY
In Managed Application Services (MAS), lots of our quick starts have steps in common. For example, several quick starts use the same set of instructions for creating a Kafka topic. Ideally, we could single-source these common steps using a reusable content snippet that we would include in each applicable quick start. That is just one example, and other opportunities for reuse exist in our quick starts. Similarly, there are plenty of opportunities for content reuse in the non-quick-start documentation that we publish on the Red Hat Customer Portal.

I've already done some work on my fork to test the use of a shared content directory in the app-services-guides repo. For example, the following links show two standard Asciidoc include statements that include the same snippet of content (from a shared-content directory) in two different guides:

My testing shows that with some coding additions to our mod docs build scripts, we can make this approach work for the modular documentation that the Asciidoc splitter tool generates from our README.adoc files.

However, when I test generation of our console quick starts from the same README files, I see that Patternfly cannot handle the type of include statements shown above. That is a significant blocker to progressing with content reuse in the app-services-guides repo.

@github-project-automation github-project-automation bot moved this to Needs triage in PatternFly Extensions Feb 1, 2023
@jbyrne-redhat jbyrne-redhat changed the title Add support for snippets within quick start tasks Add support for content snippets within quick start tasks Feb 1, 2023
@jessiehuff jessiehuff moved this from Needs triage to Not started in PatternFly Extensions Feb 6, 2023
@jessiehuff jessiehuff added this to the QS Prioritized Backlog milestone Feb 6, 2023
@github-project-automation github-project-automation bot moved this to Needs triage in PatternFly Issues Mar 29, 2024
@dlabaj dlabaj moved this from Needs triage to Backlog in PatternFly Issues Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

2 participants