8 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
Han-Wen Nienhuys
b8424a073d ReceiveCommits: uniformize commit validation error messages.
Before

  [abcdabc] missing subject; Change-Id must be in commit message
  footer

After

  commit abcdabc: missing subject; Change-Id must be in message
  footer

Change-Id: I15ca67fb591b0d237cb9217936853ec8dc706aaa
2018-08-29 12:48:24 +09:00
David Pursehouse
a1d633bb22 Doc: Consistently refer to "Web UI" rather than "WebUI"
Change-Id: Ia41e162394fa0f9ab9ae05c16db0c3032fde19cf
2014-05-02 17:21:22 +09: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
a68769eb4f Clarify error messages related to commit message footer content
Commits can be rejected due to the following issues in the commit
message:

- Change-Id tag is missing or incorrectly formatted
- Multiple Change-Id tags are present
- Signed-off-by tag is missing or does not specify the correct user

However the error messages raised in these cases do not make it clear
that the required tags are expected to be found in the footer (last
paragraph) of the commit message.

Update the error messages and related documentation to explicitly
mention that the tags should be in the commit message footer.

Change-Id: I7d2d2dfb66bed3697745733c4fe19c177e9bc56b
2012-11-13 12:18:16 +09:00
Edwin Kempin
947d666b3b added explanation for "multiple Change-Id lines" error
Added a documentation page that explains the
"multiple Change-Id lines 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: I0c6f98a41f5b8ba56d2b3e1ebf0407c03e0e1489
2010-12-29 08:04:14 +01:00