Skip to content

Commit 37a71ad

Browse files
committed
Add info about description usage
1 parent 1e8c4a8 commit 37a71ad

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

modules/contributor/pages/docs/style-guide.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Read the {asciidoc-recommended-practices} for more.
4545

4646
Add a `:description:` to every page.
4747
It should have 130 to 150 characters and describe the contents of the page.
48+
The description is used by search engines in the search result snippets.
4849

4950
== Formatting: Kubernetes style guide
5051

0 commit comments

Comments
 (0)