cloudposse / cloudposse/atmos

Expand Documentation on Use of (optional) `tenant` Label

Open
#115 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
1.4k
Forks
175
Avg merge
2d 3h
Merged PRs (30d)
134

Description

Have a question? Please checkout our [Slack Community](https://slack.cloudposse.com) or visit our [Slack Archive](https://archive.sweetops.com/).

[![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)

## 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.