Skip to content

Commit 982cf8a

Browse files
author
Timothy Poitras
authored
Merge pull request openshift#2338 from tpoitras/guideline-datauri
changes to topic template as per vikram
2 parents 2d784da + cb5f866 commit 982cf8a

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

contributing_to_docs/doc_guidelines.adoc

+10-16
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,20 @@ Every topic file should contain the following metadata at the top, with no line
1313

1414
----
1515
= Document/Topic Title <1>
16-
{product-author} <2>
17-
{product-version} <3>
18-
:data-uri: <4>
19-
:icons: <5>
20-
:toc: macro <6>
21-
:toc-title: <7>
22-
:description: <Brief description of content for search> <8>
16+
:data-uri: <2>
17+
:icons: <3>
18+
:toc: macro <4>
19+
:toc-title: <5>
2320
-----------intentional blank line--------------
24-
toc::[] <9>
21+
toc::[] <6>
2522
----
2623

2724
<1> Human readable title of document/topic title line (notice the '=' top-level header)
28-
<2> AsciiDoctor attribute for product author and gets dynamically replaced
29-
<3> AsciiDoctor attribute for product version and gets dynamically replaced
30-
<4> AsciiDoctor attribute to embed all images directly in the HTML
31-
<5> AsciiDoctor attribute for icons used in admonitions and such (TIP, NOTE, WARNING, etc.)
32-
<6> Adds a table of contents (TOC) with manual placement.
33-
<7> Overrides the default title of TOC and removes the title.
34-
<8> Brief description or synopsis of the document/topic to help with Google search.
35-
<9> Placement of the TOC.
25+
<2> AsciiDoctor attribute to embed all images directly in the HTML
26+
<3> AsciiDoctor attribute for icons used in admonitions and such (TIP, NOTE, WARNING, etc.)
27+
<4> Adds a table of contents (TOC) with manual placement.
28+
<5> Overrides the default title of TOC and removes the title.
29+
<6> Placement of the TOC.
3630

3731
After the heading block and a single whitespace line, you can include any content for the topic.
3832

contributing_to_docs/templates/topic_template.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[[contributing-to-docs-templates-topic-template]]
22
= Replace with topic title
3+
:data-uri:
4+
:icons:
35
:experimental:
46
:toc: macro
57
:toc-title:

0 commit comments

Comments
 (0)