Skip to content

Commit dab4394

Browse files
committed
Update the deployment instructions
1 parent c6d0268 commit dab4394

File tree

2 files changed

+10
-22
lines changed

2 files changed

+10
-22
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# For vscode:
22
.vscode
33
node_modules
4+
# Build output
5+
build/

README.adoc

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -42,30 +42,18 @@ $ cd docs.rubocop.org
4242
$ make build
4343
----
4444

45-
TIP: You can preview your changes by opening `docs/index.html` in your favorite browser.
45+
TIP: You can preview your changes by opening `build/site/index.html` in your favorite browser.
4646

47-
Afterwards you can publish your changes like this:
48-
49-
[source]
50-
----
51-
$ git add docs
52-
$ git commit -m 'Update site docs'
53-
$ git push
54-
----
55-
56-
You can also use `make` to publish changes in a single step:
57-
58-
[source]
59-
----
60-
$ make deploy
61-
----
47+
If you want to make changes to the manual's page structure you'll have to edit
48+
link:https://github.com/rubocop/rubocop/blob/master/doc/modules/ROOT/nav.adoc[nav.adoc].
6249

63-
It basically does `antora --fetch` and `git push`.
50+
== Deploying to GitHub Pages
6451

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

67-
If you want to make changes to the manual's page structure you'll have to edit
68-
link:https://github.com/rubocop/rubocop/blob/master/doc/modules/ROOT/nav.adoc[nav.adoc].
54+
The site is automatically deployed to GitHub pages using a GitHub Action.
55+
The action will be triggered by any push to the `master` branch.
56+
It can also be triggered manually if needed.
6957

7058
== Using Docker
7159

@@ -74,11 +62,9 @@ inside a Docker container like this:
7462

7563
[source]
7664
----
77-
$ docker run --rm -t -v $(pwd):/docs antora/antora:3.1.10 --fetch /docs/antora-playbook.yml
65+
$ docker run --rm -t -v $(pwd):/build/site antora/antora:3.1.10 --fetch /docs/antora-playbook.yml
7866
----
7967

80-
Then, proceed with `git add`, `git commit` and `git push` as mentioned above.
81-
8268
== Updating the Playbook
8369

8470
When cutting new releases you'll have to updated `antora-playbook.yml` to mention

0 commit comments

Comments
 (0)