Skip to content

Expand Documentation on Use of (optional) tenant Label #115

Open
@korenyoni

Description

@korenyoni

Have a question? Please checkout our Slack Community or visit our Slack Archive.

Slack Community

Describe the Feature

The README currently does not explain the optional tenant label and how stacks.name_pattern can be configured to either use it or not use it.

Expected Behavior

The README should clearly and concisely explain how to configure atmos to use the optional tenant label, and how to write create the stack YAML configs accordingly.

Use Case

Users attempting to use atmos.yaml in its default form will be forced to use the tenant label, and no documentation indicates that this is an optional label and how to configure atmos to not use this label.

Describe Ideal Solution

Expand the documentation as described in Expected Behaviour.

Alternatives Considered

N/A

Additional Context

https://sweetops.slack.com/archives/CQCDCLA1M/p1643728355414279

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions