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

Populating the Help page from the FAQ #155

Closed
wants to merge 1 commit into from
Closed

Populating the Help page from the FAQ #155

wants to merge 1 commit into from

Conversation

PeterTurcan
Copy link
Collaborator

Moving the user guide FAQ to the site-docs Help page. Doesn't seem like there should be conflicting sources, so will remove the FAQ from the User Guide in the next PR.

fix #79

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://155.site-docs.prtest2.cppalliance.org/contributor-guide/index.html

@alandefreitas
Copy link
Member

alandefreitas commented Nov 27, 2023

If we're just moving the content, the repo history is better if the file is just moved in a single PR. See git mv... The file from the antora docs can be removed from nav.adoc or you can create a symlink in partials so the content is always in sync: https://docs.antora.org/antora/latest/symlinks/

@PeterTurcan
Copy link
Collaborator Author

@alandefreitas OK. Any idea how to link from a page in the user-guide to a page in site-pages:

  • xref:site-pages:help.adoc[]
    does not work?

@alandefreitas
Copy link
Member

alandefreitas commented Nov 27, 2023

@alandefreitas OK. Any idea how to link from a page in the user-guide to a page in site-pages:

site-pages is not an Antora component. They are just files some script in the website project reads every once in a while.

Antora can only see what's in the component modules (in ROOT). You can create a symlink from site-pages/help.adoc to user-guide/modules/ROOT/pages/help.adoc (I might have got this wrong) and then you can do xref:help.adoc[].

@PeterTurcan PeterTurcan closed this Dec 8, 2023
@PeterTurcan
Copy link
Collaborator Author

Closing for now, looking for a better linking solution.

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 this pull request may close these issues.

FAQ
3 participants