Skip to content

Fix errors when building documentation #9370

Merged
ahukkanen merged 11 commits intodevelopfrom
docs/fix-warnings-errors
Jun 8, 2022
Merged

Fix errors when building documentation #9370
ahukkanen merged 11 commits intodevelopfrom
docs/fix-warnings-errors

Conversation

@andreslucena
Copy link
Copy Markdown
Member

🎩 What? Why?

These last few weeks I've been updating Antora, the static generator that we use for our documentation site (docs.decidim.org).

In the process we have a new feature for free: when building the site we see the errors and warnings, such as broken links, images, etc.

This PR fixes some of these, and also introduces a couple of changes that I've seen while I was at it. Most notably:

📌 Related Issues

Testing

  1. Clone https://github.com/decidim/documentation/
  2. Follow the README to install it
  3. Build to see the output (npm run build)
  4. Clone this branch locally
  5. Change the antora-playbook.yml file to match your local environment with branches, something like:
diff --git a/antora-playbook.yml b/antora-playbook.yml
index a4728c0..0e5f088 100644
--- a/antora-playbook.yml
+++ b/antora-playbook.yml
@@ -8,9 +8,9 @@ content:
       start_path: /en
       branches: master
       edit_url: "https://github.com/decidim/documentation/edit/{refname}/{path}"
-    - url: https://github.com/decidim/decidim
+    - url: /home/apereira/Work/decidim/decidim
       start_path: docs
-      branches: develop
+      branches: docs/fix-warnings-errors
     - url: https://github.com/decidim/decidim-bulletin-board
       start_path: docs
       branches: develop
  1. Build to see the output (npm run build)

♥️ Thank you!

@andreslucena andreslucena added team: documentation type: internal PRs that aren't necessary to add to the CHANGELOG for implementers labels May 27, 2022
@ahukkanen ahukkanen merged commit d791ff4 into develop Jun 8, 2022
@ahukkanen ahukkanen deleted the docs/fix-warnings-errors branch June 8, 2022 13:36
andreslucena added a commit that referenced this pull request Jul 6, 2022
* Escape AsciiDoc attributes

Fix warnings when building in Antora:

* skipping reference to missing attribute: z
* skipping reference to missing attribute: x
* skipping reference to missing attribute: y
* skipping reference to missing attribute: apikey
* skipping reference to missing attribute: foo

* Fix typo in xref

* Fix maps documentation links

* Fix system panel documentation link

* Use example.org for domain example

* Clarify API documentation and add absolute link

* Remove hardcoded order in list item index

* Add SMS service page

* Rename 'How to fix metrics' to 'Troubleshooting metrics' and link from the 'Metrics' page

* Use internal links instead of absolutes

* Add 'Customize' index page and move generator instructions to this page
eliegaboriau pushed a commit to eliegaboriau/decidim that referenced this pull request Oct 25, 2022
* Escape AsciiDoc attributes

Fix warnings when building in Antora:

* skipping reference to missing attribute: z
* skipping reference to missing attribute: x
* skipping reference to missing attribute: y
* skipping reference to missing attribute: apikey
* skipping reference to missing attribute: foo

* Fix typo in xref

* Fix maps documentation links

* Fix system panel documentation link

* Use example.org for domain example

* Clarify API documentation and add absolute link

* Remove hardcoded order in list item index

* Add SMS service page

* Rename 'How to fix metrics' to 'Troubleshooting metrics' and link from the 'Metrics' page

* Use internal links instead of absolutes

* Add 'Customize' index page and move generator instructions to this page
@alecslupu alecslupu added this to the 0.27.0 milestone Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team: documentation type: internal PRs that aren't necessary to add to the CHANGELOG for implementers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants