6 Commits

Author SHA1 Message Date
Marian Harbach
ebeb15460c Enabling linkattrs explicitly on doc pages having external links
Asciidoc may fail to render link attributes for external links
supposed to open in a new window correctly. This change adds
:linkattrs: to the beginning of such files to force parsing link
attributes correctly.

Bug: Issue 12068
Change-Id: If18be60de646ff78f672239dd4fa435fd4fd92ab
2019-12-13 10:59:57 +00:00
Marian Harbach
34253376e6 Make all external links in the documentation open in a new window
To make it easier to stay on track when reading documentation, I
added ",role=external,window=_blank" to all links in the
documentation directory that were not pointing at another piece of documentation.

Change-Id: I94bf254c90f8ebce067c765be0a2932b755a045a
2019-12-10 22:54:40 +01:00
Yuxuan 'fishy' Wang
61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00
Yuxuan 'fishy' Wang
99cb68dec4 Added searchbox to documentation.
This provides the entry point of the documentation search feature.

Change-Id: Iea2b707995c0e042829db509927384dcec7aaf43
2013-11-05 12:49:43 -08:00
David Pursehouse
221d4f6250 Documentation: Various corrections
Correct typos, spelling mistakes, and grammatical errors.

Change-Id: I80ec66de7b2228f9ff45a2f06faf576707195758
2012-06-12 14:54:54 +02:00
Edwin Kempin
c7f9e45614 added explanation for "missing Change-Id" error
Added a documentation page that explains the
"missing Change-Id in commit message" error in
details and what can be done to solve the problem.

Signed-off-by: Edwin Kempin <edwin.kempin@gmail.com>
Change-Id: I58a193f4ad86d0a81ff048e7841e322d8b200732
2010-12-29 08:02:29 +01:00