docs/README.adoc in decidim-0.26.10 vs docs/README.adoc in decidim-0.27.0.rc1
- old
+ new
@@ -34,25 +34,12 @@
. Install dependencies
. Change the antora-playbook.yml url key in source
. Build the antora playbook
. Open the generated website with your web browser
-In detail each one of these steps are:
+For instructions on how to clone the repository, install dependencies, build the antora playbook and open the generated webiste, see https://github.com/decidim/documentation[Decidim's documentation repository README file].
-[source,bash]
-----
-# 1. Clone the repository
-git clone https://github.com/decidim/documentation
-# 2. Install dependencies
-npm
-# 3. Change the antora-playbook.yml url key in source
-# 4. Build the antora playbook
-npm run build
-# 5. Open the generated website with your web browser
-xdg-open build/site/index.html
-----
-
Regarding "3. Change the antora-playbook.yml url key in source", if this is the configuration at antora-playbook.yml:
[source,yaml]
----
- url: https://github.com/decidim/decidim
@@ -66,9 +53,11 @@
----
- url: /home/youruser/Work/decidim/decidim
start_path: docs
branches: develop
----
+
+If building locally doesn't show any change, then check also that the branch corresponds with the one that you're working locally.
== Add a new link in the sidebar
For adding a new link in the sidebar you need to add it in https://raw.githubusercontent.com/decidim/documentation/master/en/modules/ROOT/nav.adoc[nav.adoc file]