Skip to content

Commit f06b94d

Browse files
committed
Updated with theme instructions
1 parent 7f54220 commit f06b94d

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Before contributing, you must sign the [Splunk Contributor License Agreement (CL
1010

1111
## Contributing to the Observability Workshop
1212

13-
When working on the workshop, we advise that you review your changes locally before committing them. Use the `hugo server` command to live preview your changes (as you type) on your local machine.
13+
When working on the workshop, we advise that you review your changes locally before committing them, although we prefer Pull Requests. Use the `hugo server` command to live preview your changes (as you type) on your local machine.
1414

1515
## Install Go & Hugo
1616

@@ -34,18 +34,6 @@ You will also need to install `yq` if it is not already installed on your system
3434
brew install yq
3535
```
3636

37-
## Install Node
38-
39-
You will also need to install `node` if it is not already installed on your system, then add the PostCSS CLI package
40-
41-
``` bash
42-
brew install node
43-
```
44-
45-
``` bash
46-
npm install postcss-cli
47-
```
48-
4937
## Cloning the reposistory
5038

5139
``` bash
@@ -64,6 +52,12 @@ hugo server
6452

6553
In most cases, the default settings with `hugo server` work well, and Hugo is available at `http://localhost:1313`. If you need to change the port, you can do so by passing the `--port` flag e.g. `hugo server --port=1314`. The documentation built from your current branch is then accessible through your favorite browser at e.g. `http://localhost:1314`.
6654

55+
## Create Content
56+
57+
The workshop uses the Hugo Relearn Theme. Documentation on how to use the theme can be found [here](https://mcshelby.github.io/hugo-theme-relearn/cont/index.html).
58+
59+
Additional documentation for the shortcodes used in the theme can be found [here](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/index.html).
60+
6761
## Optimising images
6862

6963
Install `optipng`:

0 commit comments

Comments
 (0)