Skip to content

Commit 4edf427

Browse files
committed
fix: markdown lint and broken link in contrib doc
Signed-off-by: miacycle <184569369+miacycle@users.noreply.github.com>
1 parent 6d8fda7 commit 4edf427

1 file changed

Lines changed: 22 additions & 25 deletions

File tree

content/en/kanvas/reference/contributing-to-docs.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases:
99

1010
Welcome to the GitHub repository for Layer5's documentation website!
1111

12-
The docs website is hosted at https://docs.layer5.io.
12+
The docs website is hosted at <https://docs.layer5.io>.
1313

1414
We use [Hugo](https://gohugo.io/) with the [google/docsy](https://github.com/google/docsy) theme for styling and site structure, and [Netlify](https://www.netlify.com/) to manage the deployment of the site.
1515

@@ -21,21 +21,18 @@ Here's a quick guide to updating the docs:
2121

2222
2. Make your changes and send a pull request (PR).
2323

24-
3. If you're not yet ready for a review, add "WIP" to the PR name to indicate it's a work in progress.
25-
Alternatively, you use the `/hold` [prow command](https://prow.k8s.io/command-help) in a comment to mark the PR as not ready for merge.
24+
3. If you're not yet ready for a review, add "WIP" to the PR name to indicate it's a work in progress.
2625

27-
4. Wait for the automated PR workflow to do some checks.
26+
4. Wait for the automated PR workflow to do some checks.
2827
When it's ready, you should see a comment like this: `deploy/netlify — Deploy preview ready!`
2928

3029
5. Click **Details** to the right of "Deploy preview ready" to see a preview of your updates.
3130

3231
6. Continue updating your doc and pushing your changes until you're happy with the content.
3332

34-
7. When you're ready for a review, add a comment to the PR, remove any holds or "WIP" markers, and assign a reviewer/approver.
35-
See the [Layer5 contributor guide](https://layer5.io/community/handbook/contribution).
33+
7. When you're ready for a review, add a comment to the PR, remove any holds or "WIP" markers, and assign a reviewer/approver. See the [Layer5 contributor guide](https://layer5.io/community/handbook/contribution).
3634

37-
If you need more help with the GitHub workflow, follow
38-
this [guide to a standard GitHub workflow](https://github.com/layer5io/docs/blob/master/CONTRIBUTING-gitflow.md).
35+
If you need more help with the GitHub workflow, follow this [guide to a standard GitHub workflow](https://github.com/layer5io/docs/blob/master/CONTRIBUTING-gitflow.md).
3936

4037
## Local development
4138

@@ -45,12 +42,12 @@ This section will show you how to develop the website locally, by running a loca
4542

4643
To install Hugo, follow the [instructions for your system type](https://gohugo.io/getting-started/installing/).
4744

48-
**NOTE:** we recommend that you use Hugo version `0.119.0`, as this is currently the version we deploy to Netlify.
45+
**NOTE:** we recommend that you use Hugo version `v0.140.2`, as this is currently the version we deploy to Netlify.
4946

5047
For example, using homebrew to install hugo on macOS or linux:
5148

5249
```bash
53-
# WARNING: this may install a newer version than `0.119.0`
50+
# WARNING: this may install a newer version than `v0.140.2`
5451
brew install hugo
5552
```
5653

@@ -129,7 +126,7 @@ weight = 1
129126

130127
## Docsy Theme
131128

132-
We use the [Docsy](https://www.docsy.dev/) theme for the website.
129+
We use the [Docsy](https://www.docsy.dev/) theme for the website.
133130
The theme files are managed with a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in the `themes/docsy` directory.
134131

135132
**Do not change these files**, they are not actually inside this repo, but are part of the [google/docsy](https://github.com/google/docsy) repo.
@@ -157,21 +154,21 @@ The theme holds its styles in the [`assets/scss` directory](https://github.com/l
157154

158155
You can override the default styles and add new ones:
159156

160-
* In general, put your files in the project directory structure under `website` rather than in the theme directory.
157+
* In general, put your files in the project directory structure under `website` rather than in the theme directory.
161158
Use the same file name as the theme does, and put the file in the same relative position.
162-
Hugo looks first at the file in the main project directories, if present, then at the files under the theme directory.
159+
Hugo looks first at the file in the main project directories, if present, then at the files under the theme directory.
163160
For example, the Layer5 website's [`layouts/partials/navbar.html`](https://github.com/layer5io/docs/blob/master/layouts/partials/navbar.html)
164161
overrides the theme's [`layouts/partials/navbar.html`](https://github.com/layer5io/docs/blob/master/themes/docsy/layouts/partials/navbar.html)
165162

166163
* You can update the Layer5 website's project variables in the [`_variables_project.scss` file](https://github.com/layer5io/docs/blob/master/assets/scss/_variables_project.scss).
167-
Values in that file override the [Docsy variables](https://github.com/layer5io/docs/blob/master/themes/docsy/assets/scss/_variables.scss).
164+
Values in that file override the [Docsy variables](https://github.com/layer5io/docs/blob/master/themes/docsy/assets/scss/_variables.scss).
168165
You can also use `_variables_project.scss` to specify your own values for any of the default [Bootstrap 4 variables](https://getbootstrap.com/docs/4.0/getting-started/theming/).
169166
170167
* Custom styles [`_styles_project` file](https://github.com/layer5io/docs/blob/master/assets/scss/_styles_project.scss)
171168
172169
Styling of images:
173170
174-
* To see some examples of styled images, take a look at the OAuth setup page in the Layer5 docs.
171+
* To see some examples of styled images, take a look at the OAuth setup page in the Layer5 docs.
175172
Search for `.png` in the [page source](https://raw.githubusercontent.com/layer5io/docs/master/content/en/docs/gke/deploy/oauth-setup.md).
176173
177174
* For more help, see the guide to
@@ -182,7 +179,7 @@ Styling of images:
182179
183180
The site's [front page](https://docs.layer5.io/):
184181

185-
* See the [page source](https://github.com/layer5io/docs/blob/master/content/en/_index.html).
182+
* See the [page source](<https://github.com/layer5io/docs/blob/master/content/en/>.
186183

187184
* The CSS styles are in the [project variables file](https://github.com/layer5io/docs/blob/master/assets/scss/_variables_project.scss).
188185

@@ -192,17 +189,17 @@ The site's [front page](https://docs.layer5.io/):
192189

193190
## Using Hugo shortcodes
194191

195-
Sometimes it's useful to define a snippet of information in one place and reuse it wherever we need it.
196-
For example, we want to be able to refer to the minimum version of various frameworks/libraries throughout the docs,
192+
Sometimes it's useful to define a snippet of information in one place and reuse it wherever we need it.
193+
For example, we want to be able to refer to the minimum version of various frameworks/libraries throughout the docs,
197194
without causing a maintenance nightmare.
198195
199-
For this purpose, we use Hugo's "shortcodes".
200-
Shortcodes are similar to Django variables. You define a shortcode in a file, then use a specific markup
196+
For this purpose, we use Hugo's "shortcodes".
197+
Shortcodes are similar to Django variables. You define a shortcode in a file, then use a specific markup
201198
to invoke the shortcode in the docs. That markup is replaced by the content of the shortcode file when the page is built.
202199

203200
To create a shortcode:
204201

205-
1. Add an HTML file in the `/docs/layouts/shortcodes/` directory.
202+
1. Add an HTML file in the `/docs/layouts/shortcodes/` directory.
206203
The file name must be short and meaningful, as it determines the shortcode you and others use in the docs.
207204

208205
2. For the file content, add the text and HTML markup that should replace the shortcode markup when the web page is built.
@@ -242,17 +239,17 @@ Useful Hugo docs:
242239
243240
## Versioning of the docs
244241
245-
For each stable release, we create a new branch for the relevant documentation.
242+
For each stable release, we create a new branch for the relevant documentation.
246243
For example, the documentation for the v0.2 stable release is maintained in the [v0.2-branch](https://github.com/layer5io/docs/tree/v0.2-branch).
247244
Each branch has a corresponding Netlify website that automatically syncs each merged PR.
248245
249246
The versioned sites follow this convention:
250247
251-
* `docs.layer5.io` always points to the current *master branch*
248+
* `docs.layer5.io` always points to the current _master branch_
252249
* `master.docs.layer5.io` always points to GitHub head
253250
* `vXXX-YYY.docs.layer5.io` points to the release at vXXX.YYY-branch
254251
255-
We also hook up each version to the dropdown on the website menu bar.
252+
We also hook up each version to the dropdown on the website menu bar.
256253
For information on how to update the website to a new version, see the [Layer5 release guide](https://github.com/layer5io/docs/blob/master/docs_dev/releasing.md#releasing-a-new-version-of-the-website).
257254
258255
Whenever any documents reference any source code, you should use the version shortcode in the links, like so:
@@ -261,4 +258,4 @@ Whenever any documents reference any source code, you should use the version sho
261258
https://github.com/layer5io/docs/blob/master/scripts/gke/deploy.sh
262259
```
263260
264-
This ensures that all the links in a versioned webpage point to the correct branch.
261+
This ensures that all the links in a versioned webpage point to the correct branch.

0 commit comments

Comments
 (0)