@@ -42,30 +42,18 @@ $ cd docs.rubocop.org
42
42
$ make build
43
43
----
44
44
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.
46
46
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].
62
49
63
- It basically does `antora --fetch` and `git push`.
50
+ == Deploying to GitHub Pages
64
51
65
52
NOTE: You'll need commit access to the repository for this to work.
66
53
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.
69
57
70
58
== Using Docker
71
59
@@ -74,11 +62,9 @@ inside a Docker container like this:
74
62
75
63
[source]
76
64
----
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
78
66
----
79
67
80
- Then, proceed with `git add`, `git commit` and `git push` as mentioned above.
81
-
82
68
== Updating the Playbook
83
69
84
70
When cutting new releases you'll have to updated `antora-playbook.yml` to mention
0 commit comments