[CAMEL-16499] camel-website - Add documentation how xref links works

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.x
• Component/s: documentation, website
• Estimated Complexity: Unknown
• Assignee: David Jencks
• Reporter: Claus Ibsen
• Created: 14/Apr/21 06:58
• Updated: 29/Jul/21 07:25
• Resolved: 29/Jul/21 07:25

Description

We need a section on camel-website root readme page, that talks about how you do links between pages on the website.

The xref: syntax is confusing and not intuitive how you link between: eips, components, user-manual, fag, pages between sub-projects (eg camel -> camel-k) and so forth.

For example in kamelet-eip.adoc as EIP doc, I could not link with

== More details

- xref:components::kamelet-component.adoc[Kamelet component]
- xref:manual::route-tepmplate.adoc[Route Template]
- xref:latest@camel-k:ROOT::kamelets-user.adoc[Kamelets user guide]

We also provided a small https://github.com/apache/camel-examples/tree/master/examples/kamelet[Kamelet example].

I tried 10 different things for the last two bullets, and looked other xref links, and nothing kinda worked.

So what you end up doing is NOT to have xref links at all.

Issue Links

• is related to: CAMEL-16493 camel-kamelet - Kamelet EIP