[Docs] Update the instructions for contributing to the docs

1 files changed, 38 insertions, 15 deletions

diff --git a/doc/modules/ROOT/pages/contributing.adoc b/doc/modules/ROOT/pages/contributing.adoc
index 67e171d..feb6f78 100644
--- a/doc/modules/ROOT/pages/contributing.adoc
+++ b/doc/modules/ROOT/pages/contributing.adoc
@@ -31,29 +31,52 @@ Good documentation is just as important as good code.
 Consider improving and extending this manual and the
 https://github.com/bbatsov/projectile/wiki[community wiki].
 
-=== Working on the Manual
+=== Working on the Docs
 
-The manual is generated from the markdown files in the
-https://github.com/bbatsov/projectile/tree/master/doc[doc] folder of Projectile's
-GitHub repo and is published to link:readthedocs.org[Read the Docs]. The
-http://www.mkdocs.org/[MkDocs] tool is used to convert the markdown sources to
-HTML.
+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.
+link:https://antora.org[Antora] is used to convert the manual into HTML.
+The filesystem layout is described at https://docs.antora.org/antora/2.0/component-structure/.
 
-To make changes to the manual you simply have to change the files under
-`doc`. The manual will be regenerated automatically when changes to those files
-are merged in `master` (or the latest stable branch).
+To make changes to the manual you simply have to change the files under `doc`.
+The manual will be regenerated manually periodically.
 
-You can install `MkDocs` locally and use the command `mkdocs serve` to see the
-result of changes you make to the manual locally:
+==== Installing Antora
 
-[source,sh]
+NOTE: The instructions here assume you already have (the right version of) node.js installed.
+
+Installing the Antora is super simple:
+
+[source]
+----
+$ npm i -g @antora/cli@2.0 @antora/site-generator-default@2.0
 ----
-$ cd path/to/projectile/repo
-$ mkdocs serve
+
+Check out https://docs.antora.org/antora/2.0/install/install-antora/[the detailed installation instructions]
+if you run into any problems.
+
+==== Building the Site
+
+You can build the documentation locally from the link:https://github.com/bbatsov/docs.projectile.mx[docs.projectile.mx] repo.
+
+[source]
 ----
+$ cd docs.projectile.mx
+$ antora --pull antora-playbook.yml
+----
+
+After you're done with the initial setup you can use the `deploy` script to push changes to the site:
+
+[source]
+----
+./deploy
+----
+
+NOTE: You'll need commit access to the repository for this to work.
+
+To check the generated site you can simply open `docs/index.html` in your favourite browser.
 
 If you want to make changes to the manual's page structure you'll have to edit
-https://github.com/bbatsov/projectile/blob/master/mkdocs.yml[mkdocs.yml].
+link:https://github.com/bbatsov/projectile/blob/master/doc/modules/ROOT/nav.adoc[nav.adoc].
 
 == Donations