projects
/
lttng-docs.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
contrib-guide.md: capitalize headings
[lttng-docs.git]
/
contrib-guide.md
diff --git
a/contrib-guide.md
b/contrib-guide.md
index f3cd76b646926826b75b652b4c36e7eae0446f26..5ae90797f85a603b33272795c9ff54fd1354ac1f 100644
(file)
--- a/
contrib-guide.md
+++ b/
contrib-guide.md
@@
-6,7
+6,7
@@
Documentation's source. Make sure you read it thoroughly before
contributing a change.
contributing a change.
-
b
ranches
+
B
ranches
--------
The online documentation published at <http://lttng.org/docs/> is always
--------
The online documentation published at <http://lttng.org/docs/> is always
@@
-15,7
+15,7
@@
The `master` branch contains the current documentation of the upcoming
LTTng release.
LTTng release.
-
s
tructure of sources
+
S
tructure of sources
--------------------
`toc/docs.yml` is a YAML tree of all chapters, sections and subsections.
--------------------
`toc/docs.yml` is a YAML tree of all chapters, sections and subsections.
@@
-54,7
+54,7
@@
Run it from the repository's root:
and it will potentially output a list of errors and warnings.
and it will potentially output a list of errors and warnings.
-
f
ormat of sources
+
F
ormat of sources
-----------------
The sources are made of a fusion of Markdown and HTML processed by
-----------------
The sources are made of a fusion of Markdown and HTML processed by
@@
-72,7
+72,7
@@
document. If you need to contribute, please use them when needed to
preserve the document's visual consistency.
preserve the document's visual consistency.
-####
tip/note block
+####
Tip/note/warning/error blocks
Tip/note block:
Tip/note block:
@@
-91,7
+91,8
@@
Tip/note block:
Title should be `Tip:` for a tip and `Note:` for a note.
Title should be `Tip:` for a tip and `Note:` for a note.
-#### external links
+
+#### External links
Internal links should always use Markdown
(`[caption](#doc-section)`). External links, however, need a special
Internal links should always use Markdown
(`[caption](#doc-section)`). External links, however, need a special
@@
-108,7
+109,7
@@
In these cases, add the `int` CSS class as a hint to prevent the static
analyzer from complaining (`tools/checkdocs.py`).
analyzer from complaining (`tools/checkdocs.py`).
-####
a
bbreviations
+####
A
bbreviations
Use `<abbr>` for describing abbreviations. This should only be used
for the first use of the abbreviation:
Use `<abbr>` for describing abbreviations. This should only be used
for the first use of the abbreviation:
@@
-119,7
+120,7
@@
project is an open source system software package [...]
```
```
-####
n
on-breaking spaces
+####
N
on-breaking spaces
Sometimes, a non-breaking space HTML entity (` `) needs to be
explicitly written.
Sometimes, a non-breaking space HTML entity (` `) needs to be
explicitly written.
@@
-135,7
+136,7
@@
A check is performed every 3000 ms.
```
```
-####
p
laceholders in inline code
+####
P
laceholders in inline code
You must use `<em>` to emphasize a placeholder within a `<code>` tag
because Markdown backticks (<code>`</code>) always render their
You must use `<em>` to emphasize a placeholder within a `<code>` tag
because Markdown backticks (<code>`</code>) always render their
@@
-147,7
+148,7
@@
Name your file <code>something_<em>sys</em>.c</code>, where
```
```
-####
t
erminal boxes
+####
T
erminal boxes
A terminal box, where command lines are shown, is a simple `<pre>`
with the `term` class:
A terminal box, where command lines are shown, is a simple `<pre>`
with the `term` class:
@@
-181,13
+182,13
@@
Results of commands, if needed, should be presented in a simple
</pre>
</pre>
-####
i
mages
+####
I
mages
Use
```html
<div class="img img-70">
Use
```html
<div class="img img-70">
- <img src="/images/docs/image-name.png" alt="Short description">
+ <img src="/images/docs
26
/image-name.png" alt="Short description">
</div>
```
</div>
```
@@
-200,8
+201,8
@@
basic browsers:
```html
<div class="img img-90">
```html
<div class="img img-90">
- <object data="/images/docs/image-name.svg" type="image/svg+xml">
- <img src="/images/docs/image-name.png" alt="Short description">
+ <object data="/images/docs
26
/image-name.svg" type="image/svg+xml">
+ <img src="/images/docs
26
/image-name.png" alt="Short description">
</object>
</div>
```
</object>
</div>
```
@@
-210,7
+211,7
@@
An interactive SVG object allows its text to be selected, amongst other
features.
features.
-
c
onvention
+
C
onvention
----------
A few rules to comply with in order to keep the text as
----------
A few rules to comply with in order to keep the text as
@@
-238,7
+239,7
@@
consistent as possible:
_we_ have an ongoing example.
_we_ have an ongoing example.
-
c
ommitting
+
C
ommitting
----------
If you make a change to a single contents file, prefix your Git commit
----------
If you make a change to a single contents file, prefix your Git commit
This page took
0.024865 seconds
and
4
git commands to generate.