Skip to content

Commit

Permalink
Merge pull request #185 from nikhilkalburgi/develop
Browse files Browse the repository at this point in the history
docs: improve contributing.md and Makefile
  • Loading branch information
iArchitSharma authored Jan 25, 2024
2 parents aa06926 + 921f6e4 commit f4cb652
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 10 deletions.
36 changes: 29 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,43 @@ Make sure you have the following prerequisites installed on your operating syste
npm -v
```

- [Hugo](https://gohugo.io/)
- [Go](https://go.dev/doc/install)

To verify run:

```
hugo version
go version
```

- [Gatsby.js](https://www.gatsbyjs.com/)
- [Hugo](https://gohugo.io/installation/)

To verify run:

```
gatsby --version
```
- Install a recent release of the Hugo "extended" version. If you install from
the [Hugo release page](https://github.com/gohugoio/hugo/releases), make sure
you download the `extended` version, which supports SCSS.

To verify run:

```
hugo version
```

- Install `PostCSS` so that the site build can create the final CSS assets. You
can install it locally by running the following commands from the root
directory of your project:

```sh
npm install --save-dev autoprefixer
npm install --save-dev postcss-cli
```

Starting in
[version 8 of `postcss-cli`](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md),
you must also separately install `postcss`:

```sh
npm install -D postcss
```

**Note:** If you're on a _Windows environment_ then it is highly recommended that you install [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install) both for performance and ease of use.
Expand Down
10 changes: 7 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ include .github/build/Makefile.show-help.mk
## Install docs.layer5.io dependencies on your local machine.
## See https://gohugo.io/categories/installation
setup:
hugo server -D
npm install

## Run docs.layer5.io on your local machine with draft and future content enabled.
site:
site: check-go
hugo server -D -F

## Run docs.layer5.io on your local machine. Alternate method.
Expand All @@ -36,5 +36,9 @@ clean:
hugo --cleanDestinationDir
site

.PHONY: setup build site clean site-fast
.PHONY: setup build site clean site-fast check-go

check-go:
@echo "Checking if Go is installed..."
@command -v go > /dev/null || (echo "Go is not installed. Please install it before proceeding."; exit 1)
@echo "Go is installed."

0 comments on commit f4cb652

Please sign in to comment.