Skip to content

Commit

Permalink
docs: Fixed Slugify doc in GoTemplate.md (argoproj#16685)
Browse files Browse the repository at this point in the history
* docs: Fixed Slugify doc in  GoTemplate.md

Signed-off-by: Aymen Ben Tanfous <[email protected]>

* Update docs/operator-manual/applicationset/GoTemplate.md

Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Aymen Ben Tanfous <[email protected]>

* Update docs/operator-manual/applicationset/GoTemplate.md

Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Aymen Ben Tanfous <[email protected]>

---------

Signed-off-by: Aymen Ben Tanfous <[email protected]>
Co-authored-by: Blake Pettersson <[email protected]>
  • Loading branch information
2 people authored and clement-heetch committed Feb 12, 2024
1 parent a01fdd6 commit b8f0c4a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/operator-manual/applicationset/GoTemplate.md
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

0 comments on commit b8f0c4a

Please sign in to comment.