Links
Links provide additional explanation or context for the user. Links to articles within the Docs site are also known as cross-references.
Best practices
Use links to other articles wisely. Excessive linkage interferes with readability.
To write effective link text, use the name of the article or a summary of the destination page. Do not use language such as click here or see this article.
Link to another article within the Docs site
Try to include at least one internal link in each article. Make sure the link is relevant to the topic discussed in the origin article.
To link to another article within the Docs site, use the following syntax:
link:/fusion-connectors/45/active-directory-connector-for-ac-ls-v-1-configuration-reference[Link text here]For Fusion reference and concept articles, use {version} for articles that apply to multiple Fusion versions.
For Springboard reference and concept articles, use {appType} for articles that apply to all Springboard products.
- Recommended
-
✅ To access this list through the command line, follow the instructions in List all Docker images and versions.
- Recommended
-
✅ Signals provide the data that Fusion uses to generate collaborative recommendations.
- Not recommended
-
✘ To access this list through the command line, follow the instructions here.
Link to an external site
To link to sites outside of doc.lucidworks.com, include the full URL and use ^ after the URL link text. The ^ informs Gatsby of an external link.
link:https://academy.lucidworks.com/grafana-for-managed-fusion[LucidAcademy training course on the Customer Dashboard^]- Recommended
-
✅ Sign up for a free LucidAcademy training course on the Customer Dashboard to learn the best practices for utilizing the Grafana dashboard.
- Not recommended
-
✘ Sign up for a free LucidAcademy training course on the Customer Dashboard here to learn the best practices for utilizing the Grafana dashboard.
| External links include other URLs on the lucidworks.com domain outside of doc.lucidworks.com. |
Link to a section of a Docs site article
To link to a section within an article, first create an anchor tag immediately preceding the section you want to link to.
Anchor names must be unique within an article. Use _ (underscore) instead of a space to separate words within an anchor name. Create anchor tags only before section titles. Do not create anchor tags before paragraphs.
In the following examples, replace [[ANCHOR_NAME]] with the name of your anchor tag.
- Recommended
[[ANCHOR_NAME]]
== Section header
This is the first paragraph of a section.- Not recommended
This is the second paragraph of a section.
[[ANCHOR_NAME]]
This is the third paragraph of a section.After creating the anchor tag, you can create the link to the anchor.
To link to another section in the same article:
link:#ANCHOR_NAME[Link text here]To link to an anchor tag in a different article:
link:/fusion-connectors/45/active-directory-connector-for-ac-ls-v-1-configuration-reference#ANCHOR_NAME[Link text here]Resources
The following resources discuss specific topics on links: