Uploaded image for project: 'Bamboo Data Center'
  1. Bamboo Data Center
  2. BAM-20527

Improve the way we show different document types in YAML reference

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • None
    • Documentation (User)
    • None
    • 2
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      Problem

      Recently we added the concept of different documents inside the same YAML file. This concept gives us more flexibility since we now can have different repositories for different sections of the same YAML file.

      Although this is a great idea, the docs are not clear about it and a user needs to read all of it to be able to understand that different sections are needed in the same YAML file depending on which properties/features he is trying to configure.

      Suggested Solution

      In the YAML reference docs, create one section for each document type.
      Different sections could have different colors or at least a definition of each document that property fits in. 

       

      Attachments

        Issue Links

          Activity

            People

              2cd4b6cecf0f Jacek Krawczyk
              dsantos Daniel Santos
              Votes:
              2 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated: