9 Commits

Author SHA1 Message Date
David Shevitz
c47f23698a Clean up remaining command reference files
Change-Id: I96c2d95a22c3b0e9629471ea994e25b72349fe4c
2018-11-12 19:22:29 +00:00
Michael Ochmann
b99feabd88 Fix formatting of example blocks
With the new stylesheet example blocks (delimited with ====) are
rendered as rather intrusive boxes with large padding in yellow
and grey.

This patch replaces the example blocks with simple code blocks
(delimited with ----) that better match the overall style of the
documentation.

Change-Id: Id95387cdb153332c2066e2d5e378697647dbca52
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-07 14:06:31 +02:00
Michael Ochmann
e2d76a1c23 Fix broken synopsis formatting in documentation
Most of the cmd-xxxx.txt pages were still using the legacy 'italics'
asciidoc [1], which caused the synopsis sections to render like this:

'ssh' -p <port> 'gerrit some-command'

Furthermore, the line breaks and indentations were not rendered.

Replaced the legacy 'italics" with _italics_ in all synopsis sections
and changed the block type to [verse]. Verse blocks preserve indents
and line breaks (like <pre> in HTML), but still allow text formatting.

Fixed also some other minor mistakes and formatting errors.

[1] http://asciidoctor.org/docs/migration/#migration-cheatsheet

Change-Id: I457c5e42e3758789f29541d38d6f6c2e25532897
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-06 10:54:42 +02:00
David Myllykangas
511823f835 Documentation update for cmd-plugin
Update the Access section on documentation of the cmd-plugin
command to also include config to enable the command.

Change-Id: I815275009494db6ce3027a2705b0056146ba7a0f
2015-01-21 11:03:08 +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
d85b687536 Bypass the rendering differences in AsciiDoctor.
AsciiDoctor have different understanding of [verse] with asciidoc, causing some
rendering differences. To get similar result with asciidoc, we use something
else instead of [verse] now.

Screenshots:
before:
http://imgur.com/JKMdBiv
after:
http://imgur.com/yFVvVac

Change-Id: I14e84f0e998e1e87b633681e8028ad657bde07e4
2013-11-15 11:47:46 -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
Edwin Kempin
b778e21a66 Document that on reload of a plugin a new plugin configuration gets active
Change-Id: I292de021d8aa1ce7fc1fb95b55f7536d7dd41cd2
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2012-07-18 12:48:36 +02:00
Edwin Kempin
f729574ac4 Document SSH commands gerrit plugin {ls|install|remove|reload}
Change-Id: If6a45760cbc4ebdfb6cfeea4b39034cae1415b82
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2012-07-17 16:07:02 +02:00