Skip to content

ytt: document schema/desc and schema/title #760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
peschmae wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

ytt: document schema/desc and schema/title #760

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion site/content/ytt/docs/develop/how-to-write-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ system_domain: ""

declares the Data Value, with the name `system_domain` to be of type **string** with the default value of an **empty string** (i.e. `""`).

Additionally, a Data Value can also have a **title** and a **description** to make the schema easier to understand.

For example,
```yaml
#@data/values-schema
---
#@schema/title "The system domain name"
#@schema/desc "The domain this system will be available at"
system_domain: ""
```

---
## Implying Types

Expand Down Expand Up @@ -279,4 +290,4 @@ honeycomb:
---
## Next Steps

Once you've declared your Data Values, they can be referenced in `ytt` templates as described in [Using Data Values > Referencing Data Values](how-to-use-data-values.md#referencing-data-values)
Once you've declared your Data Values, they can be referenced in `ytt` templates as described in [Using Data Values > Referencing Data Values](how-to-use-data-values.md#referencing-data-values)