[
https://issues.apache.org/jira/browse/CAMEL-16499?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Claus Ibsen updated CAMEL-16499:
--------------------------------
Fix Version/s: (was: 3.10.0)
3.x
> camel-website - Add documentation how xref links works
> ------------------------------------------------------
>
> Key: CAMEL-16499
> URL: https://issues.apache.org/jira/browse/CAMEL-16499
> Project: Camel
> Issue Type: Improvement
> Components: documentation, website
> Reporter: Claus Ibsen
> Assignee: Zoran Regvart
> Priority: Major
> Fix For: 3.x
>
>
> 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
> {code}
> == 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].
> {code}
> 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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
