add frontmatter

pingcap · Sep 4, 2023 · 5c4de69 · 5c4de69
1 parent 3136fa6
commit 5c4de69
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/resources/doc-templates/template-concept.md b/resources/doc-templates/template-concept.md
@@ -1,6 +1,6 @@
 ---
-title: xxx (The same as L1 heading)
-summary: xxx (summarize this doc in one sentence)
+title: (The same as L1 heading) concept such as "Garbage Collection Overview" in 59 chars or less. Include the keywords of this document. Test title here https://moz.com/learn/seo/title-tag
+summary: summarize this doc in 115 to 145 characters. Start with a verb that tells the users what they can get from this doc, for example, "Learn the working principles of something". If your intro paragraph describes your article's intent, you can use it here, edited for length.
 ---
 
 # L1 heading (the same as title in the metadata)

diff --git a/resources/doc-templates/template-new-feature.md b/resources/doc-templates/template-new-feature.md
@@ -1,6 +1,6 @@
 ---
-title: New Feature Name (The same as L1 heading)
-summary: xxx (summarize this doc in one sentence)
+title: (The same as L1 heading) Feature name such as "Clustered Indexes" in 59 chars or less. Include the keywords of this document. Test title here https://moz.com/learn/seo/title-tag
+summary: summarize this doc in 115 to 145 characters. Start with a verb that tells the users what they can get from this doc, for example, "Learn what is clustered indexes and how to use clustered index to help you...". If your intro paragraph describes your article's intent, you can use it here, edited for length.
 ---
 
 # New Feature Name (the same as title in the metadata)

diff --git a/resources/doc-templates/template-reference.md b/resources/doc-templates/template-reference.md
@@ -1,6 +1,6 @@
 ---
-title: xxx (The same as L1 heading)
-summary: xxx (summarize this doc in one sentence)
+title: (The same as L1 heading) such as "Garbage Collection Configuration" in 59 chars or less. Include the keywords of this document. Test title here https://moz.com/learn/seo/title-tag
+summary: summarize this doc in 115 to 145 characters. Start with a verb that tells the users what they can get from this doc, for example, "Learn all the configuration options that you can use in garbage collection". If your intro paragraph describes your article's intent, you can use it here, edited for length.
 ---
 
 # L1 heading (the same as title in the metadata)

diff --git a/resources/doc-templates/template-task.md b/resources/doc-templates/template-task.md
@@ -1,6 +1,6 @@
 ---
-title: xxx (The same as L1 heading)
-summary: xxx (summarize this doc in one sentence)
+title: (The same as L1 heading) such as "Get Started with TiDB" in 59 chars or less. Include the keywords of this document. Test title here https://moz.com/learn/seo/title-tag
+summary: summarize this doc in 115 to 145 characters. Start with a verb that tells the users what they can get from this doc, for example, "Learn how to quickly get started with TiDB in 10 minutes". If your intro paragraph describes your article's intent, you can use it here, edited for length.
 ---
 
 # L1 heading (the same as title in the metadata)

diff --git a/resources/doc-templates/template-troubleshooting.md b/resources/doc-templates/template-troubleshooting.md
@@ -1,6 +1,6 @@
 ---
-title: xxx (The same as L1 heading)
-summary: xxx (summarize this doc in one sentence)
+title: (The same as L1 heading) such as "Troubleshoot Increased Read and Write Latency" in 59 chars or less. Include the keywords of this document. Test title here https://moz.com/learn/seo/title-tag
+summary: summarize this doc in 115 to 145 characters. Start with a verb that tells the users what they can get from this doc, for example, "Learn how to troubleshoot your cluster when you encounter xxx". If your intro paragraph describes your article's intent, you can use it here, edited for length.
 ---
 
 # L1 heading (the same as title in the metadata)