Uploaded image for project: 'SonarQube'
  1. SonarQube
  2. SONAR-11307

Enhance embedded documentation with "Nav Title" metadata

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 7.5
    • Component/s: Documentation, Web
    • Labels:
      None
    • Edition:
      Community
    • Production Notes:
      None

      Description

      Currently we declare a title: foo metadata in each page, and it's used both in the navigation bar and at the top of the page.

      It would be nice to have the option to use two different strings. So something like

      ---
      title: GitHub Integrtion
      nav: GitHub
      url:...
      ---
      

      This would allow you to have a short title in the navigation bar, e.g. "GitHub" (filed under "Integrations") and a longer title on the page itself: "GitHub Integration"

        Attachments

          Activity

            People

            Assignee:
            pascal.mugnier Pascal Mugnier (Inactive)
            Reporter:
            ann.campbell.2 Ann Campbell
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Due:
              Created:
              Updated:
              Resolved: