From 6ba1534f108287d53842c5b9226e141b6f2c7d1d Mon Sep 17 00:00:00 2001 From: Siddhant Prateek Date: Thu, 28 Oct 2021 22:31:00 +0530 Subject: [PATCH 1/2] Mentioned Markdown flavor in Contribution new content Signed-off-by: Siddhant Prateek --- content/en/docs/contribute/new-content/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/en/docs/contribute/new-content/_index.md b/content/en/docs/contribute/new-content/_index.md index 501e417985..7d629ee549 100644 --- a/content/en/docs/contribute/new-content/_index.md +++ b/content/en/docs/contribute/new-content/_index.md @@ -56,12 +56,14 @@ prior to submitting new content. The information details follow. - Write Kubernetes documentation in Markdown and build the Kubernetes site using [Hugo](https://gohugo.io/). +- Kubernetes documentation uses [CommonMark](https://commonmark.org/) as its flavor of Markdown. - The source is in [GitHub](https://github.com/kubernetes/website). You can find Kubernetes documentation at `/content/en/docs/`. Some of the reference documentation is automatically generated from scripts in the `update-imported-docs/` directory. - [Page content types](/docs/contribute/style/page-content-types/) describe the presentation of documentation content in Hugo. +- You can use [Docsy shortcodes](https://www.docsy.dev/docs/adding-content/shortcodes/) or our custom Hugo shortcode to contribute to our documentation. - In addition to the standard Hugo shortcodes, we use a number of [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our documentation to control the presentation of content. From 12854d0586af042c734622742c2ef68dfc63091b Mon Sep 17 00:00:00 2001 From: Siddhant Prateek Mahanayak <43869046+siddhantprateek@users.noreply.github.com> Date: Fri, 12 Nov 2021 23:01:48 +0530 Subject: [PATCH 2/2] Suggested Changes Co-authored-by: Rey Lejano --- content/en/docs/contribute/new-content/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/contribute/new-content/_index.md b/content/en/docs/contribute/new-content/_index.md index 7d629ee549..5dee6a513b 100644 --- a/content/en/docs/contribute/new-content/_index.md +++ b/content/en/docs/contribute/new-content/_index.md @@ -63,7 +63,7 @@ prior to submitting new content. The information details follow. the `update-imported-docs/` directory. - [Page content types](/docs/contribute/style/page-content-types/) describe the presentation of documentation content in Hugo. -- You can use [Docsy shortcodes](https://www.docsy.dev/docs/adding-content/shortcodes/) or our custom Hugo shortcode to contribute to our documentation. +- You can use [Docsy shortcodes](https://www.docsy.dev/docs/adding-content/shortcodes/) or [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) to contribute to Kubernetes documentation. - In addition to the standard Hugo shortcodes, we use a number of [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our documentation to control the presentation of content.