Skip to content

Commit 30c55d1

Browse files
committed
[Docs] Update Antora instructions
1 parent 82cecc2 commit 30c55d1

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/modules/ROOT/pages/contributing.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,14 @@ Tests should run fine in `shell-mode` or `term-mode`. It's also possible to use
5353
== Documentation
5454

5555
Good documentation is just as important as good code.
56-
5756
Consider improving and extending this manual and the
5857
https://github.com/bbatsov/projectile/wiki[community wiki].
5958

6059
=== Working on the Docs
6160

6261
The manual is generated from the AsciiDoc files in the https://github.com/bbatsov/projectile/tree/master/doc[doc] folder of Projectile's GitHub repo and is published to https://docs.projectile.mx.
6362
https://antora.org[Antora] is used to convert the manual into HTML.
64-
The filesystem layout is described at https://docs.antora.org/antora/2.0/component-structure/.
63+
The filesystem layout is described at https://docs.antora.org/antora/latest/component-structure/.
6564

6665
To make changes to the manual you simply have to change the files under `doc`.
6766
The manual will be regenerated manually periodically.
@@ -74,10 +73,11 @@ Installing the Antora is super simple:
7473

7574
[source]
7675
----
77-
$ npm i -g @antora/[email protected] @antora/[email protected]
76+
$ cd docs.projectile.mx
77+
$ npm install
7878
----
7979

80-
Check out https://docs.antora.org/antora/2.0/install/install-antora/[the detailed installation instructions]
80+
Check out https://docs.antora.org/antora/latest/install/install-antora/[the detailed installation instructions]
8181
if you run into any problems.
8282

8383
==== Building the Site
@@ -87,14 +87,14 @@ You can build the documentation locally from the https://github.com/bbatsov/docs
8787
[source]
8888
----
8989
$ cd docs.projectile.mx
90-
$ antora --pull antora-playbook.yml
90+
$ make build
9191
----
9292

93-
After you're done with the initial setup you can use the `deploy` script to push changes to the site:
93+
After you're done with the initial setup you can use the `make` to push changes to the site:
9494

9595
[source]
9696
----
97-
./deploy
97+
$ make deploy
9898
----
9999

100100
NOTE: You'll need commit access to the repository for this to work.

0 commit comments

Comments
 (0)