You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,4 +110,4 @@ The current Technical Advisory Groups will be spun down during 2025 and replaced
110
110
111
111
### Updating TAG or SubProject README files
112
112
113
-
To modify the README files for individual TAGs or subprojects, please **do not edit them directly**. Instead, the source of truth for these files is the [`tags.yaml`](https://github.com/cncf/toc/blob/main/tags.yaml) file. To understand the process for updating these READMEs by modifying `tags.yaml`, please refer to the [Updating TOC TAG and Subproject README Files document](./generator/updating-tag-and-toc=subproject-readme-files.md).
113
+
To modify the README files for individual TAGs or TOC SubProjects, please **do not edit them directly**. Instead, the source of truth for these files is the [`tags.yaml`](https://github.com/cncf/toc/blob/main/tags.yaml) file. To understand the process for updating these READMEs by modifying `tags.yaml`, please refer to the [Updating TOC TAG and SubProject README Files document](./generator/updating-tag-and-toc=subproject-readme-files.md).
Copy file name to clipboardExpand all lines: generator/updating-tag-and-toc=subproject-readme-files.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Updating TOC TAG and Subproject README Files
1
+
# Updating TOC TAG and TOC SubProject README Files
2
2
3
3
This document outlines the process for updating the README files located in the [tags](https://github.com/cncf/toc/tree/main/tags) and [toc_subprojects](https://github.com/cncf/toc/tree/main/toc_subprojects) directories. These README files are automatically generated and updated based on the content of the [`tags.yaml`](https://github.com/cncf/toc/blob/main/tags.yaml) file.
4
4
5
-
**The Single Source of Truth: `tags.yaml`**
5
+
## **The Single Source of Truth: `tags.yaml`**
6
6
7
-
The `tags.yaml` file serves as the central source of information for generating and updating the README files for both TAGs and subprojects. To modify the content of these READMEs, you **must** update the `tags.yaml` file directly.
7
+
The `tags.yaml` file serves as the central source of information for generating and updating the README files for both TAGs and TOC SubProjects. To modify the content of these READMEs, you **must** update the `tags.yaml` file directly.
8
8
9
-
**Who can Update:**
9
+
## **Who can Update:**
10
10
11
11
Anyone can create a pull request in the `cncf/toc` repository, only TOC members can review and merge changes to the `tags.yaml` file.
12
12
13
-
**How to Update:**
13
+
## **How to Update:**
14
14
15
15
1.**Locate the `tags.yaml` file:** This file is located at the root of the `cncf/toc` repository: [https://github.com/cncf/toc/blob/main/tags.yaml](https://github.com/cncf/toc/blob/main/tags.yaml).
16
16
@@ -19,7 +19,7 @@ Anyone can create a pull request in the `cncf/toc` repository, only TOC members
19
19
3.**Create a Pull Request (PR):**
20
20
***Important:** A PR that aims to update the TAG and subproject README files **must only contain changes to the `tags.yaml` file.** Any other changes in the PR will not trigger the automatic README updates.
21
21
22
-
**Automation in Action:**
22
+
## **Automation in Action:**
23
23
24
24
The `github-project-automation` and `cncf-automation-bot` handle the automatic updates of the README files based on your changes to `tags.yaml`:
25
25
@@ -34,6 +34,6 @@ The `github-project-automation` and `cncf-automation-bot` handle the automatic u
34
34
* This new PR will contain both your changes to the `tags.yaml` file and the automatically generated updates to the relevant README files.
35
35
* The `cncf-automation-bot` will automatically close the original PR from your fork and add comments to both the original and the new PR to link them.
36
36
37
-
**Key Takeaway:**
37
+
## **Key Takeaway:**
38
38
39
39
To update the README files in the `tags` and `toc_subprojects` directories, your PR **must only include modifications to the `tags.yaml` file**. The automation will then take care of generating and updating the corresponding README files.
0 commit comments