Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-409

Restructure Pipeline and Blue Ocean under the "Using" chapter

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Done (View Workflow)
    • Priority: Minor
    • Resolution: Won't Do
    • Component/s: content
    • Labels:
      None
    • Similar Issues:

      Description

      I'll need to do some surgery on the rendering of the navigation to make this look sensible.


      Currently, the User Handbook part of the Jenkins User Documentation only supports 1 level of depth (as you can see from this link).

      It would be great if we could implement 2 levels of depth (i.e. a hierarchy of 3 levels).

      This would allow us to nest the Pipeline and Blue Ocean sections within the Using Jenkins section, which from a documentation organization perspective, makes more sense to the reader.

      The FreeBSD Handbook, which is loosely how we're aiming to structure the Jenkins User Handbook documentation on, is based on a hierarchy of 3 levels.

        Attachments

          Issue Links

            Activity

            Hide
            ggaskell Giles Gaskell added a comment - - edited

            Thanks very much R. Tyler Croy - sorry I should've created this ticket. Just added a link to the task that's related to this one.

            Show
            ggaskell Giles Gaskell added a comment - - edited Thanks very much R. Tyler Croy - sorry I should've created this ticket. Just added a link to the task that's related to this one.
            Hide
            ggaskell Giles Gaskell added a comment - - edited

            Following a discussion with Liam Newman, I am going to close this issue with a resolution of "Won't Do" because the main reason for creating this JIRA was to be able to nest the Pipeline and Blue Ocean chapters within the Using Jenkins chapter (as discussed in WEBSITE-400).

            However, the Using Jenkins chapter will now cover all non-administration aspects of Jenkins usage which aren't directly related to Pipeline or Blue Ocean Jenkins features - e.g. Using credentials.

            Being able to nest the Pipeline and Blue Ocean chapters within Using Jenkins would be a 'nice to have' from a documentation structure perspective, but taking into consideration the existing design of the Jenkins User Documentation (i.e. especially with no search function), doing so would make the Pipeline and Blue Ocean chapters less 'discoverable'.

            Therefore, as part of PR 1328, the introductory sections of each chapter will clearly indicate the contents of the chapters.

            Show
            ggaskell Giles Gaskell added a comment - - edited Following a discussion with Liam Newman , I am going to close this issue with a resolution of "Won't Do" because the main reason for creating this JIRA was to be able to nest the Pipeline and Blue Ocean chapters within the Using Jenkins chapter (as discussed in WEBSITE-400 ). However, the Using Jenkins chapter will now cover all non-administration aspects of Jenkins usage which aren't directly related to Pipeline or Blue Ocean Jenkins features - e.g. Using credentials. Being able to nest the Pipeline and Blue Ocean chapters within Using Jenkins would be a 'nice to have' from a documentation structure perspective, but taking into consideration the existing design of the Jenkins User Documentation (i.e. especially with no search function), doing so would make the Pipeline and Blue Ocean chapters less 'discoverable'. Therefore, as part of PR 1328 , the introductory sections of each chapter will clearly indicate the contents of the chapters.

              People

              Assignee:
              ggaskell Giles Gaskell
              Reporter:
              rtyler R. Tyler Croy
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: