Uploaded image for project: 'Repose'
  1. REP-6338

Update Default configuration values in the docs to a consistent flavor

    Details

    • Type: Story
    • Status: Resolved (View workflow)
    • Priority: Medium
    • Resolution: Done
    • Affects versions: None
    • Fix versions: 8.7.3.0
    • Components: None
    • Labels:
      None
    • Sprint:
      Sprint 156
    • Story Points:
      2
    • Capitalizable:
      True

      Description

      In the configuration sections in our documentation, default values should be specified in a consistent way. The team talked it over, and we settled on the following:

      Default: `value`
      

      Specifically:

      • In the callout, adding a new line before specifying the default value.
      • Using the phrase "Default" (singular).
      • Using a colon.
      • Putting the value between two backticks to make it code-like.

      Acceptance Criteria:

      • All of the default configuration values currently specified in the versioned documentation are updated to be consistent with the above format.

        Attachments

          Activity

            People

            • Assignee:
              wdschei Bill Scheidegger
              Reporter:
              wdschei Bill Scheidegger
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: