Skip to content

Use the new style for configuration variables description #6385

@fabaff

Description

@fabaff

A while back an advance way to describe the configuration variables was introduced.

{% configuration %}
api_key:
  description: The API key to access the service.
  required: true
  type: string
name:
  description: Name to use in the frontend.
  required: false
  default: The default name to use in the frontend.
  type: string
{% endconfiguration %}

At the moment not all platform and component documentation is ported to the new style.

This the tracking issue. Please don't close but add as a reference to your Pull request.

Metadata

Metadata

Assignees

No one assigned

    Labels

    HacktoberfestAn PR on this issue (or the PR itself) is eligible towards Hacktoberfest!help-wantedWanna help? Jump in!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions