Skip to content

Commit 83e2781

Browse files
add note about updating page titles
Signed-off-by: Alexa Kreizinger <[email protected]>
1 parent b2d5cfc commit 83e2781

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ curly quotes. If you copy-paste from one of these tools, you must correct the qu
117117

118118
When you create a new `.md` file for a new page, you must add an entry to this repository's [`SUMMARY.md` file](https://github.com/fluent/fluent-bit-docs/blob/master/SUMMARY.md) (or ask a maintainer to add it on your behalf). If you don't update `SUMMARY.md`, the new page won't appear in the table of contents on the Fluent Bit docs site.
119119

120+
Similarly, if you update the `#h1` header to change the title of an existing page, make sure to update that page's `SUMMARY.md` entry to match.
121+
120122
## Linters
121123

122124
This repository runs linters as GitHub Actions for each pull request. If a linter finds errors or makes suggested changes, you can view these results in the **Files changed** tab.

0 commit comments

Comments
 (0)