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.

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

Link from Docbook dev docs to Markdown files #20530

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Link from Docbook dev docs to Markdown files #20530

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/guide/cockpit-guide.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@

<part id="development">
<title>Developer Guide</title>
<subtitle>See also the documentation in <ulink url="https://github.com/cockpit-project/cockpit/tree/main/doc">the .md files directly in the doc folder of the cockpit source</ulink> and <ulink url="https://github.com/cockpit-project/cockpit/blob/main/HACKING.md">the HACKING.md file in the source</ulink>. These are currently not rendered here, but only the content of the folder doc/guide in the source is rendered here. Help is welcome in converting this documentation from Docbook XML to Markdown and merging these.</subtitle>
Copy link
Member

Choose a reason for hiding this comment

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

Squeezing this into the subtitle is too much of an abuse:

image

How about moving that into a new sub-file and including it here like the others?

Also, HACKING.md doesn't really belong here. This developer guide is about the cockpit API, i.e. how to use it to create your own pages. HACKING.md is about developing on cockpit itself. I don't mind much mentioning it here somewhere, but this is too prominent and distracting.

tree/main/doc is more useful, in particular protocol.md, but also the other files.

<xi:include href="embedding.xml"/>
<xi:include href="packages.xml"/>
<xi:include href="urls.xml"/>
Expand Down