From 53feb72910f0976ba2587fcc5e569490de2d7212 Mon Sep 17 00:00:00 2001 From: tstromberg Date: Tue, 13 Aug 2019 16:54:20 -0700 Subject: [PATCH] Add documentation for contributing docs --- .../en/docs/Contributing/documentation.en.md | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 site/content/en/docs/Contributing/documentation.en.md diff --git a/site/content/en/docs/Contributing/documentation.en.md b/site/content/en/docs/Contributing/documentation.en.md new file mode 100644 index 0000000000..56017f0484 --- /dev/null +++ b/site/content/en/docs/Contributing/documentation.en.md @@ -0,0 +1,59 @@ +--- +linkTitle: "Documentation" +title: "Contributing to minikube documentation" +date: 2019-07-31 +weight: 2 +--- + +minikube's documentation is in [Markdown](https://www.markdownguide.org/cheat-sheet/), and generated using the following tools: + +* [Hugo](https://gohugo.io) +* [Docsy](https://www.docsy.dev) + +In production, the minikube website is served using [Netlify](http://netlify.com/) + +## Local documentation website + +To serve documentation pages locally, clone the `minikube` repository and run: + +`make site` + +NOTE: On Windows, our site currently causes Hugo to `panic`. + +## Lint + +We recommend installing [markdownlint](https://github.com/markdownlint/markdownlint) to find issues with your markdown file. Once installed, you can use this handy target: + +`make mdlint` + +## Style Guidelines + +We follow the [Kubernetes Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/) + +## Linking between documents + +For compile-time checking of links, use one of the following forms to link between documentation pages: + + +```go-html-template +{{}} +{{}} +{{}} +{{}} +{{}} +{{}} +{{}} +{{}} +``` + +For more information, please see [Hugo: Links and Cross References](https://gohugo.io/content-management/cross-references/) + +## Pull Request Previews + +When reviewing documentation PR's, look for the test that says: + +**✓ deploy/netlify** Deploy preview ready! *Details* + +The `Details` link will point to a site preview URL in the form of: + +