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

Docs code snippets report an error #56

Closed
Thefolle opened this issue May 19, 2022 · 4 comments · Fixed by #83
Closed

Docs code snippets report an error #56

Thefolle opened this issue May 19, 2022 · 4 comments · Fixed by #83

Comments

@Thefolle
Copy link

Docs code snippets report an error

The Neo4j docs related to Quarkus have broken code snippets.

What I see on most snippets is:
Unresolved include directive in modules/ROOT/pages/index.adoc - include::../../../../integration-tests/src/main/java/io/quarkus/it/neo4j/FruitResource.java[]

I use Firefox.

Could you please check?

@michael-simons
Copy link
Contributor

Thanks @Thefolle much appreciated.

Hello @gsmet I am unsure about the docs build: How can I tell antora / the asciidoc config here to make include things correctly? My local preview works (i.e. open the adoc file in IDEA). Would be nice if you can help me here please.

@michael-simons
Copy link
Contributor

Hmm @gastaldi do you know?

@gastaldi
Copy link
Member

gastaldi commented Aug 3, 2022

@michael-simons you need to create symbolic links under an examples directory in the docs/modules/ROOT directory. See https://docs.antora.org/antora/latest/symlinks/ for more details

I created #83 to fix this

@gastaldi gastaldi linked a pull request Aug 3, 2022 that will close this issue
@michael-simons
Copy link
Contributor

Thanks a lot, much appreciated!

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.

3 participants