Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Local development and preview is broken #131

Closed
andreslucena opened this issue Jun 26, 2023 · 1 comment · Fixed by #133
Closed

Local development and preview is broken #131

andreslucena opened this issue Jun 26, 2023 · 1 comment · Fixed by #133

Comments

@andreslucena
Copy link
Member

For local development you need to change the antora configuration in antora-playbook.yml, and we don't have that documented anywhere.

Steps to reproduce:

  1. Create a change in any file
  2. Run the npm run build command
  3. See that you don't see the change in the build site

As a workaround, you can make this change in your local antora-playbook.yml (without committing the changes):

diff --git a/antora-playbook.yml b/antora-playbook.yml
index 41fcc02..3210fd7 100644
--- a/antora-playbook.yml
+++ b/antora-playbook.yml
@@ -4,12 +4,8 @@ site:
   start_page: v0.27@en:ROOT:index.adoc
 content:
   sources:
-    - url: https://github.com/decidim/documentation
+    - url: .
       start_path: en
-      branches:
-        - release/0.27-stable
-        - release/0.26-stable
-        - develop
       edit_url: "https://github.com/decidim/documentation/edit/{refname}/{path}"
     - url: https://github.com/decidim/decidim
       start_path: docs

The solution would involve having two playbook configurations, improving the documentation and explaining a bit how antora works, and having two commands: npm run build and npm run prod-build or something like that.

@andreslucena
Copy link
Member Author

This was detected while checking out #129

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant