Skip to content

Commit 0d4c17f

Browse files
committed
Refine snippet
1 parent 03f65bf commit 0d4c17f

File tree

1 file changed

+4
-24
lines changed

1 file changed

+4
-24
lines changed

docs/contribute/_snippets/changelog-fields.md

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,7 @@ title:
99
type:
1010

1111
# A required string that contains the type of change.
12-
# It can be one of:
13-
# - feature: new functionality
14-
# - enhancement: extends functionality but does not break or fix existing behavior
15-
# - bug-fix: fixes a problem in a previous version
16-
# - known-issue: problems that we are aware of in a given version
17-
# - breaking-change: a change to previously-documented behavior
18-
# - deprecation: functionality that is being removed in a later release
19-
# - docs: major documentation updates or reorgs
20-
# - regression: functionality that no longer works or behaves incorrectly
21-
# - security: an advisory about potential security vulnerabilities
22-
# - other: does not fit into any of the other categories
12+
# Refer to https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs for the acceptable values.
2313

2414
products:
2515

@@ -29,6 +19,7 @@ products:
2919

3020
# A required string with a predefined product ID used for release note routing,
3121
# filters, and categorization.
22+
# Refer to https://github.com/elastic/docs-builder/blob/main/config/products.yml for the acceptable values.
3223

3324
target:
3425

@@ -40,10 +31,7 @@ products:
4031
lifecycle:
4132

4233
# An optional string for new features and enhancements that have a specific availability.
43-
# It can be one of the following:
44-
# - preview
45-
# - beta
46-
# - ga
34+
# Refer to https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs for the acceptable values.
4735

4836
##### Optional fields #####
4937
action:
@@ -91,13 +79,5 @@ pr:
9179
subtype:
9280

9381
# An optional string that applies only to breaking changes and further subdivides that type.
94-
# It can be one of:
95-
# - api: refers to changes that break an api
96-
# - behavioral: refers to changes the way something works
97-
# - configuration: refers to changes that break the configuration
98-
# - dependency: refers to changes like removing support for third-party products
99-
# - subscription: refers to changes that break licensing behavior
100-
# - plugin: refers to changes that break a plugin
101-
# - security: refers to changes that break authentication, authorization, or permissions
102-
# - other: does not fit into any of the other categories
82+
# Refer to https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs for the acceptable values.
10383
```

0 commit comments

Comments
 (0)