Skip to content

Commit c3e2e3e

Browse files
committed
[Docs] Update the instructions for contributing to the docs
1 parent 32f6b09 commit c3e2e3e

1 file changed

Lines changed: 38 additions & 15 deletions

File tree

doc/modules/ROOT/pages/contributing.adoc

Lines changed: 38 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,29 +31,52 @@ Good documentation is just as important as good code.
3131
Consider improving and extending this manual and the
3232
https://github.com/bbatsov/projectile/wiki[community wiki].
3333

34-
=== Working on the Manual
34+
=== Working on the Docs
3535

36-
The manual is generated from the markdown files in the
37-
https://github.com/bbatsov/projectile/tree/master/doc[doc] folder of Projectile's
38-
GitHub repo and is published to link:readthedocs.org[Read the Docs]. The
39-
http://www.mkdocs.org/[MkDocs] tool is used to convert the markdown sources to
40-
HTML.
36+
The manual is generated from the AsciiDoc files in the link:https://github.com/bbatsov/projectile/tree/master/doc[doc] folder of Projectile's GitHub repo and is published to https://docs.projectile.mx.
37+
link:https://antora.org[Antora] is used to convert the manual into HTML.
38+
The filesystem layout is described at https://docs.antora.org/antora/2.0/component-structure/.
4139

42-
To make changes to the manual you simply have to change the files under
43-
`doc`. The manual will be regenerated automatically when changes to those files
44-
are merged in `master` (or the latest stable branch).
40+
To make changes to the manual you simply have to change the files under `doc`.
41+
The manual will be regenerated manually periodically.
4542

46-
You can install `MkDocs` locally and use the command `mkdocs serve` to see the
47-
result of changes you make to the manual locally:
43+
==== Installing Antora
4844

49-
[source,sh]
45+
NOTE: The instructions here assume you already have (the right version of) node.js installed.
46+
47+
Installing the Antora is super simple:
48+
49+
[source]
50+
----
51+
$ npm i -g @antora/cli@2.0 @antora/site-generator-default@2.0
5052
----
51-
$ cd path/to/projectile/repo
52-
$ mkdocs serve
53+
54+
Check out https://docs.antora.org/antora/2.0/install/install-antora/[the detailed installation instructions]
55+
if you run into any problems.
56+
57+
==== Building the Site
58+
59+
You can build the documentation locally from the link:https://github.com/bbatsov/docs.projectile.mx[docs.projectile.mx] repo.
60+
61+
[source]
5362
----
63+
$ cd docs.projectile.mx
64+
$ antora --pull antora-playbook.yml
65+
----
66+
67+
After you're done with the initial setup you can use the `deploy` script to push changes to the site:
68+
69+
[source]
70+
----
71+
./deploy
72+
----
73+
74+
NOTE: You'll need commit access to the repository for this to work.
75+
76+
To check the generated site you can simply open `docs/index.html` in your favourite browser.
5477

5578
If you want to make changes to the manual's page structure you'll have to edit
56-
https://github.com/bbatsov/projectile/blob/master/mkdocs.yml[mkdocs.yml].
79+
link:https://github.com/bbatsov/projectile/blob/master/doc/modules/ROOT/nav.adoc[nav.adoc].
5780

5881
== Donations
5982

0 commit comments

Comments
 (0)