Skip to content

Commit b99b671

Browse files
timflannagananik120
authored andcommitted
content: Add link to the Docsy docs in the contribution guidelines (operator-framework#160)
* content: Add link to the Docsy docs in the contribution guidelines Update the contribution guidelines and add a link to the Docsy documentation instead of the broken `[Docsy user guide](wherever it goes)` reference that's currently being deployed. * content: Update list styling so bullet points are rendered correctly
1 parent 692ae79 commit b99b671

File tree

1 file changed

+16
-17
lines changed
  • content/en/docs/contribution-guidelines

1 file changed

+16
-17
lines changed

content/en/docs/contribution-guidelines/_index.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,49 +24,48 @@ Here's a quick guide to updating the docs. It assumes you're familiar with the
2424
GitHub workflow and you're happy to use the automated preview of your doc
2525
updates:
2626

27-
1. Fork [olm-docs](https://github.com/operator-framework/olm-docs) on GitHub.
28-
1. Make your changes and send a pull request (PR).
29-
1. If you're not yet ready for a review, add "WIP" to the PR name to indicate
27+
- Fork [olm-docs](https://github.com/operator-framework/olm-docs) on GitHub.
28+
- Make your changes and send a pull request (PR).
29+
- If you're not yet ready for a review, add "WIP" to the PR name to indicate
3030
it's a work in progress. (**Don't** add the Hugo property
3131
"draft = true" to the page front matter, because that prevents the
3232
auto-deployment of the content preview described in the next point.)
33-
1. Wait for the automated PR workflow to do some checks. When it's ready,
33+
- Wait for the automated PR workflow to do some checks. When it's ready,
3434
you should see a comment like this: **deploy/netlify — Deploy preview ready!**
35-
1. Click **Details** to the right of "Deploy preview ready" to see a preview
35+
- Click **Details** to the right of "Deploy preview ready" to see a preview
3636
of your updates.
37-
1. Continue updating your doc and pushing your changes until you're happy with
37+
- Continue updating your doc and pushing your changes until you're happy with
3838
the content.
39-
1. When you're ready for a review, add a comment to the PR, and remove any
39+
- When you're ready for a review, add a comment to the PR, and remove any
4040
"WIP" markers.
4141

4242
## Updating a single page
4343

4444
If you've just spotted something you'd like to change while using the docs, Docsy has a shortcut for you:
4545

46-
1. Click **Edit this page** in the top right hand corner of the page.
47-
1. If you don't already have an up to date fork of the project repo, you are prompted to get one - click **Fork this repository and propose changes** or **Update your Fork** to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.
48-
1. Follow the rest of the [Quick start with Netlify](#quick-start-with-netlify) process above to make, preview, and propose your changes.
46+
- Click **Edit this page** in the top right hand corner of the page.
47+
- If you don't already have an up to date fork of the project repo, you are prompted to get one - click **Fork this repository and propose changes** or **Update your Fork** to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.
48+
- Follow the rest of the [Quick start with Netlify](#quick-start-with-netlify) process above to make, preview, and propose your changes.
4949

5050
## Previewing your changes locally
5151

5252
If you want to run your own local Hugo server to preview your changes as you work:
5353

54-
1. Follow the instructions in [Getting started](/docs/getting-started) to install Hugo and any other tools you need. You'll need at least **Hugo version 0.45** (we recommend using the most recent available version), and it must be the **extended** version, which supports SCSS.
55-
1. Fork [olm-docs](https://github.com/operator-framework/olm-docs), then create a local copy using `git clone`. Don’t forget to use `--recurse-submodules` or you won’t pull down some of the code you need to generate a working site.
54+
- Follow the instructions in [Getting started](/docs/getting-started) to install Hugo and any other tools you need. You'll need at least **Hugo version 0.45** (we recommend using the most recent available version), and it must be the **extended** version, which supports SCSS.
55+
- Fork [olm-docs](https://github.com/operator-framework/olm-docs), then create a local copy using `git clone`. Don’t forget to use `--recurse-submodules` or you won’t pull down some of the code you need to generate a working site.
5656

5757
```bash
5858
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
5959
```
6060

61-
1. Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
62-
1. Continue with the usual GitHub workflow to edit files, commit them, push the
63-
changes up to your fork, and create a pull request.
61+
- Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
62+
- Continue with the usual GitHub workflow to edit files, commit them, push the changes up to your fork, and create a pull request.
6463

6564
## Creating an issue
6665

6766
If you've found a problem in the docs, but you're not sure how to fix it yourself, please create an issue in the [olm-docs repo](https://github.com/operator-framework/olm-docs). You can also create an issue about a specific page by clicking the **Create Issue** button in the top right hand corner of the page.
6867

6968
## Useful resources
7069

71-
* [Docsy user guide](wherever it goes): All about Docsy, including how it manages navigation, look and feel, and multi-language support.
72-
* [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo.
70+
- [Docsy user guide](https://www.docsy.dev/docs/): All about Docsy, including how it manages navigation, look and feel, and multi-language support.
71+
- [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo.

0 commit comments

Comments
 (0)