Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-68669

Improving the Steps Documentation Layout on jenkins.io

XMLWordPrintable

      The layout will be improved in the following ways - 

      • Make the existing sidebar static and scrollable.
      • Make a new sidebar docked under the primary sidebar on the Pipeline Steps Reference page consisting of the list of plugins, clicking which would send the user to the respective step details page. 
      • Dock the table of contents on the step details page under the primary sidebar such that it remains static.
      • Collapse and format parameter contents corresponding to each step.
      • Add instructions about snippet generator wherever necessary.

          [JENKINS-68669] Improving the Steps Documentation Layout on jenkins.io

          Vihaan Thora created issue -
          Vihaan Thora made changes -
          Status Original: Open [ 1 ] New: In Progress [ 3 ]
          Kristin Whetstone made changes -
          Link New: This issue relates to WEBSITE-798 [ WEBSITE-798 ]
          Vihaan Thora made changes -
          Attachment New: plugin-page-example.png [ 58138 ]
          Vihaan Thora made changes -
          Attachment New: plugin-page-example-2.png [ 58139 ]
          Vihaan Thora made changes -
          Attachment New: index-page.png [ 58140 ]
          Vihaan Thora made changes -
          Attachment Original: index-page.png [ 58140 ]
          Vihaan Thora made changes -
          Attachment Original: plugin-page-example.png [ 58138 ]
          Vihaan Thora made changes -
          Attachment Original: plugin-page-example-2.png [ 58139 ]
          Vihaan Thora made changes -
          Description Original: The layout will be improved in the following ways - 
           * Make the existing sidebar static and scrollable.
           * Make a new sidebar docked under the primary sidebar on the Pipeline Steps Reference page consisting of the list of plugins, clicking which would send the user to the respective step details page. 
           * Dock the table of contents on the step details page under the primary sidebar such that it remains static.
           * Collapse and format parameter contents corresponding to each step.
           * Add instructions about snippet generator wherever necessary.

          The following link would be used to maintain wireframes for the suggested layout - [https://www.figma.com/file/r5GwVJBaL6XdR4dBJZlNIM/Layout-Improvements?node-id=5%3A3]

                      		New: The layout will be improved in the following ways - 
           * Make the existing sidebar static and scrollable.
           * Make a new sidebar docked under the primary sidebar on the Pipeline Steps Reference page consisting of the list of plugins, clicking which would send the user to the respective step details page. 
           * Dock the table of contents on the step details page under the primary sidebar such that it remains static.
           * Collapse and format parameter contents corresponding to each step.
           * Add instructions about snippet generator wherever necessary.
          Vihaan Thora made changes -
          Link New: This issue relates to WEBSITE-799 [ WEBSITE-799 ]

            vihaanthora Vihaan Thora
            vihaanthora Vihaan Thora
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: