Skip to content
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

docs: Fixed Slugify doc in GoTemplate.md #16685

Merged
merged 4 commits into from
Jan 19, 2024
Merged

docs: Fixed Slugify doc in GoTemplate.md #16685

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5f0b7e
docs: Fixed Slugify doc in GoTemplate.md
Aym3nTN Dec 22, 2023
fbeb9a5
Update docs/operator-manual/applicationset/GoTemplate.md
Aym3nTN Jan 19, 2024
3ec431e
Merge branch 'argoproj:master' into slugify-docs
Aym3nTN Jan 19, 2024
b7e0d8e
Update docs/operator-manual/applicationset/GoTemplate.md
Aym3nTN Jan 19, 2024
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
4 changes: 3 additions & 1 deletion docs/operator-manual/applicationset/GoTemplate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ An additional `normalize` function makes any string parameter usable as a valid
with hyphens and truncating at 253 characters. This is useful when making parameters safe for things like Application
names.

Another function has `slugify` function has been added which, by default, sanitizes and smart truncate (means doesn't cut a word into 2). This function accepts a couple of arguments:
Another `slugify` function has been added which, by default, sanitizes and smart truncates (it doesn't cut a word into 2). This function accepts a couple of arguments:
- The first argument (if provided) is an integer specifying the maximum length of the slug.
- The second argument (if provided) is a boolean indicating whether smart truncation is enabled.
- The last argument (if provided) is the input name that needs to be slugified.
Expand Down Expand Up @@ -206,6 +206,8 @@ ApplicationSet controller provides:
1. contains no more than 253 characters
2. contains only lowercase alphanumeric characters, '-' or '.'
3. starts and ends with an alphanumeric character

- `slugify`: sanitizes like `normalize` and smart truncates (it doesn't cut a word into 2) like described in the [introduction](#introduction) section.
- `toYaml` / `fromYaml` / `fromYamlArray` helm like functions


Expand Down
Loading