Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-16499

camel-website - Add documentation how xref links works

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 3.x
    • Component/s: documentation, website
    • Labels:
      None
    • Estimated Complexity:
      Unknown

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                zregvart Zoran Regvart
                Reporter:
                davsclaus Claus Ibsen
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: