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

Add anchor links to the docsite FAQ questions #1386

Open
dgmccart opened this issue Dec 9, 2024 · 3 comments
Open

Add anchor links to the docsite FAQ questions #1386

dgmccart opened this issue Dec 9, 2024 · 3 comments
Assignees

Comments

@dgmccart
Copy link
Collaborator

dgmccart commented Dec 9, 2024

There is currently no way on the user's side to copy a link for a specific FAQ question. Melissa has implemented links to open accordions already, and we use this functionality when linking to individual questions in the FAQ from the Portal UI.

We simply need to add the anchors to allow our users to copy those links from an FAQ question.

@melissawm
Copy link
Collaborator

melissawm commented Dec 13, 2024

Looking more closely, it looks like we can already do that. Every FAQ question has a name attribute. From anywhere in the docs, if you use the syntax

{ref}`My question <faq-name>`

This will create a link to the specific FAQ question. For example,

{ref}`Go here to get help <get-help>`

will create a link with caption "Go here to get help", linking to

.

@melissawm
Copy link
Collaborator

We want to have external links to specific FAQ questions as well.

@dgmccart
Copy link
Collaborator Author

dgmccart commented Jan 6, 2025

Great, looks like for our internal usage we can create links to reference FAQ questions that will open the accordions. Next step is to provide a user-facing option, such as a copiable anchor links.

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

No branches or pull requests

2 participants