Add support for content snippets within quick start tasks
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- typescript
调研方向
Start by reviewing the quick-start generation flow and the mod docs build scripts, then reproduce the include behavior using the README.adoc examples linked in the issue. Done means shared content snippets can be included in the generated console quick starts as well as the modular documentation.
由索引模型根据 Issue 内容生成。
描述
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.
Jira Issue: PF-1881
- 主要语言
- TypeScript
- 星标
- 15
- 派生
- 47
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
patternfly/patternfly-quickstarts 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 58/100
-
难度 3/5 1-2 天 新手友好度 45/100
-
难度 5/5 一周以上 新手友好度 20/100
-
PF Team
难度 4/5 3-5 天 新手友好度 35/100
-
PF Team
难度 2/5 1-3 小时 新手友好度 45/100
查看 patternfly/patternfly-quickstarts 的全部 Issue
相似的 Issue
-
enhancement
难度 1/5 1 小时以内 新手友好度 80/100
alunduil/projects-v2-sync#21 ·
-
难度 2/5 1-3 小时 新手友好度 85/100
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 74/100
testcontainers/testcontainers-node#1539 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
christopher-buss/eslint-plugin-flawless#72 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
openwatersio/slackwater-database#281 ·
维护者通常 1 天内回复