Fix errors when building documentation #9370
Merged
Conversation
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
…m the 'Metrics' page
ahukkanen
approved these changes
Jun 8, 2022
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎩 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
npm run build)antora-playbook.ymlfile to match your local environment with branches, something like:npm run build)