This eliminates the last Makefile in our code base.
Also change the section style within ReleaseNotes from asciidoc style to
asciidoctor style.
Also I feel that put images/link.png under ReleaseNotes and deal with
all the resource packing is too stupid, so I used the unicode emoji
instead of the picture ("🔗"). If this is too crazy, we can also use "#"
instead :) This also affects documentation rendering.
Other side effects:
1. The css of release notes switched from default asciidoc css into
default asciidoctor css.
2. The section anchors for ReleaseNotes/index.html changed from "2_13"
to "s2_13", because asciidoctorj is unhappy with anchors without
letters.
Change-Id: I4adf2ce090385cc6b699445012f10a009892aaac
We tried building Gerrit's documentation using the asciidoctor's
standard CSS style and for many people the result looks better
than Gerrit's default doc.css.
The search box is rendered with fixed position now. With the
asciidoctor default style sheet the "position:absolute" attribute no
longer worked as intended, because there are other elements in the
page with a "position" attribute. So the search box was placed randomly
somewhere next to a section header and screwed up the text layout
completely.
Test Plan:
$ buck build Documentation:html
$ open buck-out/gen/Documentation/html__tmp/Documentation/index.html
Change-Id: Ia276aeb5c79b9fbd9589db444a83c084f07aee40
Also-by: Michael Ochmann <michael.ochmann@sap.com>
Use the canonical syntax to specify the python executable to use.
Avoids a fatal error if /usr/bin/python is a too old version (< 2.7).
Change-Id: I3e8affb52be993d35c0dcf90774d962a59ef5635
* stable-2.10:
Show link on hover for h4 headings in documentation
Update ReleaseNotes-2.10
Do not include project watchers on new draft changes
Fix missing return after %submit is rejected
Change-Id: I04836a9001a829b78e682ffbc62ebbdcba682f3f
E.g. in cmd-stream-events.txt we use h4 headings for the different
events and it would be nice to be able to link to them.
Change-Id: I1aaf496852a1793b34f1c694a2b2d486af0a028e
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
For supporting users it is often useful to send them links to a
certain section in the documentation. The Gerrit documenation contains
a lot of anchors, but they are not easily accessible. If the section
is linked from the TOC the link to the section can be gained by
clicking on the link in the TOC. To link to other elements it is often
needed to check the HTML source code to find out the link target.
Make the links to section headings and anchors easier accessible by
displaying a link icon when the mouse is hovered over the heading or
anchor. By clicking on the link icon the page anchor is set and the
link can be copied from the address bar of the browser.
Having this functionality for anchors is especially useful for linking
to certain configuration parameters in the config-gerrit.html page.
The link icon is taken from the 'Freebie: Application Icon Set' [1]
which is licensed under the Creative Commons Attribution 3.0 Unported
License [2].
[1] http://tympanus.net/codrops/2012/10/02/freebie-application-icon-set-png-psd-csh/
[2] http://creativecommons.org/licenses/by/3.0/deed.en_US
Change-Id: I4377ea23ad76143fd4caa78afc30b82690e533ff
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
(cherry picked from commit a92861fb0126238014fc603257da65748efb05ca)
For supporting users it is often useful to send them links to a
certain section in the documentation. The Gerrit documenation contains
a lot of anchors, but they are not easily accessible. If the section
is linked from the TOC the link to the section can be gained by
clicking on the link in the TOC. To link to other elements it is often
needed to check the HTML source code to find out the link target.
Make the links to section headings and anchors easier accessible by
displaying a link icon when the mouse is hovered over the heading or
anchor. By clicking on the link icon the page anchor is set and the
link can be copied from the address bar of the browser.
Having this functionality for anchors is especially useful for linking
to certain configuration parameters in the config-gerrit.html page.
The link icon is taken from the 'Freebie: Application Icon Set' [1]
which is licensed under the Creative Commons Attribution 3.0 Unported
License [2].
[1] http://tympanus.net/codrops/2012/10/02/freebie-application-icon-set-png-psd-csh/
[2] http://creativecommons.org/licenses/by/3.0/deed.en_US
Change-Id: I4377ea23ad76143fd4caa78afc30b82690e533ff
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
Search boxes in documentation are useful when search feature is
available, but it's useless when we host the documentation statically.
Add this option so we can generate search-free version of the
documentation.
Change-Id: I35aadee989ae04b7bbcffd67011634cd0dd085c1
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
Asciidoctor doesn't support the conf file, so we remove it, do the macro
replacing ourselves, and put all the attributes into the command line
parameters.
Change-Id: I21b49e5a2d75ff0f9b52f26fccaae42fcbaa0837
