Skip to content

RHIDP-6146: Create developer-focused TechDocs content #1082

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

RHIDP-6146: Create developer-focused TechDocs content #1082

wants to merge 2 commits into from
+141 −0

Conversation

linfraze
Copy link
Member

@linfraze linfraze commented Apr 17, 2025 •
edited
Loading

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Apr 17, 2025 •
edited
Loading

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1082/ @ 04/22/25 20:42:46

linfraze
linfraze commented Apr 22, 2025
View reviewed changes
modules/techdocs/proc-techdocs-view-docs.adoc
Comment on lines +9 to +11
In TechDocs, a document might be part of a book that contains other documents that are related to the same topic.

Clicking the name of a document in the table on the *Documentation* page opens the document in a book page. The name of the book is displayed on book the page. The book page contains the following elements:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@benwilcock do you have any thoughts on this "book" concept? Not sure if there is another way that you or the user expects the docs to refer to this structure and UI page.

@benwilcock
Copy link

In 3.1.1 what about the case where a user wants to add techdocs via a reference to an existing catalog-info.yaml (the docs with your code approach)? In this scenario the docs and the code would be in the same repo and the catalog-info.yaml would be used to refer to the docs. The docs would then be registered automatically and ingested as part of the usual code ingestion process.

@linfraze
Copy link
Member Author

@AndrienkoAleksandr as part of the tech review, can you please help me address Ben's comment? TBH, I'm not sure what needs to be changed or added to cover that use case, since we already explain that the docs and code are in the same repo and walk the user through how to import docs with the catalog-info.yaml, so I might be missing something. Thanks!

In 3.1.1 what about the case where a user wants to add techdocs via a reference to an existing catalog-info.yaml (the docs with your code approach)? In this scenario the docs and the code would be in the same repo and the catalog-info.yaml would be used to refer to the docs. The docs would then be registered automatically and ingested as part of the usual code ingestion process.

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

@themr0c themr0c themr0c left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
do-no-merge/review-in-progress 👀 Peer review done 📘 Technical review needed 🔩 Test all the procedures
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@linfraze @rhdh-bot @benwilcock @themr0c