Skip to content

Commit 32a883e

Browse files
XRFXLPlalitadithya
XRFXLP
and
lalitadithya
authored
feat: github worklows and issue template changes (#1306)
Signed-off-by: Ajay Mishra <ajmishra@nvidia.com> Co-authored-by: Lalit Adithya <ladithyav@nvidia.com>
1 parent 451cb62 commit 32a883e

16 files changed

Lines changed: 1272 additions & 62 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ body:
2828
- label: I can reproduce this issue
2929
required: true
3030

31+
- type: checkboxes
32+
id: terms
33+
attributes:
34+
label: Code of Conduct
35+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/NVSentinel/blob/main/CODE_OF_CONDUCT.md).
36+
options:
37+
- label: I agree to follow NVSentinel's Code of Conduct
38+
required: true
39+
3140
- type: textarea
3241
id: description
3342
attributes:
@@ -45,6 +54,8 @@ body:
4554
- Core Service
4655
- Fault Management
4756
- Deployment/Config
57+
- Preflight
58+
- Plugins
4859
- Other
4960
validations:
5061
required: true

‎.github/ISSUE_TEMPLATE/documentation_request.yml‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
name: Documentation Request
16+
description: Request new or missing NVSentinel documentation
17+
title: "[Docs]: "
18+
labels: ["area/docs", "needs-triage"]
19+
20+
body:
21+
- type: checkboxes
22+
id: prerequisites
23+
attributes:
24+
label: Prerequisites
25+
description: Please review existing [documentation issues](https://github.com/NVIDIA/NVSentinel/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocs) before submitting.
26+
options:
27+
- label: I searched existing documentation and open documentation issues
28+
required: true
29+
30+
- type: checkboxes
31+
id: terms
32+
attributes:
33+
label: Code of Conduct
34+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/NVSentinel/blob/main/CODE_OF_CONDUCT.md).
35+
options:
36+
- label: I agree to follow NVSentinel's Code of Conduct
37+
required: true
38+
39+
- type: dropdown
40+
id: priority
41+
attributes:
42+
label: Priority
43+
description: How important is this documentation request?
44+
options:
45+
- Critical (currently preventing usage)
46+
- High
47+
- Medium
48+
- Low (would be nice)
49+
validations:
50+
required: true
51+
52+
- type: dropdown
53+
id: area
54+
attributes:
55+
label: Documentation Area
56+
options:
57+
- Installation/Deployment
58+
- Configuration
59+
- Health Monitors
60+
- Fault Management
61+
- Preflight
62+
- Plugins
63+
- API/Interface
64+
- Runbooks
65+
- Other
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: missing_docs
71+
attributes:
72+
label: Missing Documentation
73+
description: What future or missing documentation would help?
74+
placeholder: A command, configuration option, or workflow is mentioned but not explained.
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: searched_locations
80+
attributes:
81+
label: Where did you look?
82+
description: List docs, files, or links you checked before opening this request.
83+
placeholder: |
84+
- README.md
85+
- docs/configuration/README.md
86+
- docs/preflight.md
87+
validations:
88+
required: false

‎.github/ISSUE_TEMPLATE/documentation_update.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
name: Documentation Update
16+
description: Request corrections or updates to existing NVSentinel documentation
17+
title: "[Docs]: "
18+
labels: ["area/docs", "needs-triage"]
19+
20+
body:
21+
- type: checkboxes
22+
id: prerequisites
23+
attributes:
24+
label: Prerequisites
25+
description: Please review existing [documentation issues](https://github.com/NVIDIA/NVSentinel/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocs) before submitting.
26+
options:
27+
- label: I searched existing documentation and open documentation issues
28+
required: true
29+
30+
- type: checkboxes
31+
id: terms
32+
attributes:
33+
label: Code of Conduct
34+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/NVSentinel/blob/main/CODE_OF_CONDUCT.md).
35+
options:
36+
- label: I agree to follow NVSentinel's Code of Conduct
37+
required: true
38+
39+
- type: dropdown
40+
id: priority
41+
attributes:
42+
label: Priority
43+
description: How important is this documentation update?
44+
options:
45+
- Critical (currently preventing usage)
46+
- High
47+
- Medium
48+
- Low (would be nice)
49+
validations:
50+
required: true
51+
52+
- type: input
53+
id: location
54+
attributes:
55+
label: Documentation Location
56+
description: Link to the existing docs or source that needs correction.
57+
placeholder: https://github.com/NVIDIA/NVSentinel/blob/main/docs/OVERVIEW.md
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: problem
63+
attributes:
64+
label: Problem
65+
description: What is incorrect, outdated, unclear, or missing from the current documentation?
66+
placeholder: The docs say to use one configuration key, but the Helm chart uses another.
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: correction
72+
attributes:
73+
label: Proposed Correction
74+
description: Optional. Suggest the wording or technical change you expect.
75+
placeholder: Replace the old configuration key with the current value and add a short example.
76+
validations:
77+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ body:
2626
- label: I searched existing issues
2727
required: true
2828

29+
- type: checkboxes
30+
id: terms
31+
attributes:
32+
label: Code of Conduct
33+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA/NVSentinel/blob/main/CODE_OF_CONDUCT.md).
34+
options:
35+
- label: I agree to follow NVSentinel's Code of Conduct
36+
required: true
37+
2938
- type: textarea
3039
id: summary
3140
attributes:
@@ -61,6 +70,8 @@ body:
6170
- Fault Management
6271
- Deployment/Config
6372
- API/Interface
73+
- Preflight
74+
- Plugins
6475
- New Component
6576
- Multiple Components
6677
validations:

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 0 additions & 62 deletions
This file was deleted.

‎.github/labeler.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# Purpose: path rules consumed by actions/labeler in workflows/labeler.yml.
16+
# Contract: area/* labels here should stay in sync with issue-triage.yml so
17+
# issue and PR automation use the same taxonomy.
18+
19+
area/ci:
20+
- changed-files:
21+
- any-glob-to-any-file:
22+
- ".github/**"
23+
- "scripts/**"
24+
25+
area/docs:
26+
- changed-files:
27+
- any-glob-to-any-file:
28+
- "docs/**"
29+
- "fern/**"
30+
- "**/*.md"
31+
32+
area/deployment:
33+
- changed-files:
34+
- any-glob-to-any-file:
35+
- "distros/**"
36+
- "deployments/**"
37+
- "Tiltfile"
38+
- ".ctlptl.yaml"
39+
40+
area/health-monitors:
41+
- changed-files:
42+
- any-glob-to-any-file:
43+
- "health-monitors/**"
44+
45+
area/fault-management:
46+
- changed-files:
47+
- any-glob-to-any-file:
48+
- "fault-quarantine/**"
49+
- "fault-remediation/**"
50+
- "node-drainer/**"
51+
- "gpu-reset/**"
52+
53+
area/preflight:
54+
- changed-files:
55+
- any-glob-to-any-file:
56+
- "preflight/**"
57+
- "preflight-checks/**"
58+
59+
area/core:
60+
- changed-files:
61+
- any-glob-to-any-file:
62+
- "commons/**"
63+
- "data-models/**"
64+
- "store-client/**"
65+
- "platform-connectors/**"
66+
67+
area/api:
68+
- changed-files:
69+
- any-glob-to-any-file:
70+
- "api/**"
71+
- "**/*.proto"
72+
73+
area/plugins:
74+
- changed-files:
75+
- any-glob-to-any-file:
76+
- "plugins/**"
77+
78+
area/tests:
79+
- changed-files:
80+
- any-glob-to-any-file:
81+
- "tests/**"

0 commit comments

Comments
 (0)