js.waku.guide/README.md

# Description

This repository is the source for https://js.waku.guide/.

It is built using [Hugo](https://gohugo.io/) static site generator.

# Development

You will need to [install Hugo](https://gohugo.io/getting-started/installing) and pull submodules:

```sh
git submodule update --init
```

To start a server that also builds the page use:

```sh
hugo server
```

Will expose the built page under http://localhost:1313/.

# Continuous Integration

Two branches are built by [our Jenkins instance](https://ci.status.im/):

- `master` is deployed to https://js.waku.guide/ by [CI](https://ci.status.im/job/website/job/js.waku.guide/)
- `develop` is deployed to https://dev-js.waku.guide/ by [CI](https://ci.status.im/job/website/job/dev-js.waku.guide/)

PRs should be made for `develop` branch and `master` should be [rebased](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) on `develop` once changes are verified.
add initial README.md Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:29:34 +00:00			`# Description`

ci: change docs.wakuconnect.dev to js.waku.guide https://github.com/waku-org/js.waku.guide/issues/63 Signed-off-by: Jakub Sokołowski <jakub@status.im> 2022-11-08 18:13:04 +00:00			`This repository is the source for https://js.waku.guide/.`
add initial README.md Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:29:34 +00:00
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-12-09 14:27:58 +00:00			`It is built using [Hugo](https://gohugo.io/) static site generator.`
add initial README.md Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:29:34 +00:00
			`# Development`

replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-12-09 14:27:58 +00:00			`You will need to [install Hugo](https://gohugo.io/getting-started/installing) and pull submodules:`
Fix test script (#47) 2022-03-17 03:27:11 +00:00
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-12-09 14:27:58 +00:00			```sh
			`git submodule update --init`
add initial README.md Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:29:34 +00:00			```
Fix test script (#47) 2022-03-17 03:27:11 +00:00
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-12-09 14:27:58 +00:00			`To start a server that also builds the page use:`
Fix test script (#47) 2022-03-17 03:27:11 +00:00
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-12-09 14:27:58 +00:00			```sh
			`hugo server`
add initial README.md Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:29:34 +00:00			```
Fix test script (#47) 2022-03-17 03:27:11 +00:00
replace mdBook with Hugo for site generation An attempt to get multi-language support with a simple site generator: https://gohugo.io/ Research issue: https://github.com/vacp2p/docs.dappconnect.dev/issues/7 Theme: https://themes.gohugo.io/themes/hugo-book/ I've dropped the Waku specs part for simplicity of the PR, you can re-add it later yourself @D4nte . Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-12-09 14:27:58 +00:00			`Will expose the built page under http://localhost:1313/.`
add initial README.md Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:29:34 +00:00
			`# Continuous Integration`

add Jenkinsfile for CI builds Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:35:01 +00:00			`Two branches are built by [our Jenkins instance](https://ci.status.im/):`

ci: change docs.wakuconnect.dev to js.waku.guide https://github.com/waku-org/js.waku.guide/issues/63 Signed-off-by: Jakub Sokołowski <jakub@status.im> 2022-11-08 18:13:04 +00:00			- `master` is deployed to https://js.waku.guide/ by [CI](https://ci.status.im/job/website/job/js.waku.guide/)
			- `develop` is deployed to https://dev-js.waku.guide/ by [CI](https://ci.status.im/job/website/job/dev-js.waku.guide/)
add Jenkinsfile for CI builds Signed-off-by: Jakub Sokołowski <jakub@status.im> 2021-09-29 11:35:01 +00:00
			PRs should be made for `develop` branch and `master` should be [rebased](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) on `develop` once changes are verified.