File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 2929
3030Each document in the collection is named after the version it represents (e.g.
3131` 4.20.1.md ` ) and contains a YAML front matter describing the release's
32- properties. The body of the document, which is in Markdown format, starts with
33- an optional bulleted list of highlights ( an "overview") followed by the release
34- notes.
32+ properties. The body of the document, which is in
33+ [ flavoured ] ( #markdown-flavour ) Markdown format, starts with an optional
34+ bulleted list of highlights (an "overview") followed by the release notes.
3535
3636### Required fields
3737
@@ -79,6 +79,19 @@ The stable series (e.g. `4.19.x`) currently in support are configured in the
7979` _data/projects.yml ` file. This determines which releases are shown on the
8080Download pages.
8181
82+ ### Markdown flavour
83+
84+ You can use the following extra syntax elements in the release documents:
85+
86+ * ** GitHub ticket references** - Prefix the issue or PR number with a hash sign
87+ and put the whole in parentheses, for example: ` (#1234) ` . These will be
88+ converted into clickable links.
89+ * ** Man page references** - Use italics for the man page name, followed by the
90+ section number in parentheses, for example: ` *rpm*(8) ` . These will be
91+ converted to clickable links. Note that only our
92+ [ own] ( https://rpm-software-management.github.io/rpm/man/ ) man pages will be
93+ linked, though.
94+
8295## News entries
8396
8497For generic announcements, we use the
You can’t perform that action at this time.
0 commit comments