Doc contribution

Signed-off-by: Thomas Poignant <[email protected]>

Author: thomaspoignant

CONTRIBUTING.md

@@ -26,9 +26,9 @@ Every feature or bug should come with an associate test to keep the coverage as
 
 We are maintaining 2 documentations:
 - [README.md](README.md) which contains everything you need to know to start working with the module.
-- [go-feature-flag website](https://thomaspoignant.github.io/go-feature-flag/) which is the full detail documentation of the module.
+- [go-feature-flag website](https://gofeatureflag.org) which is the full detail website containing the documentation.
 
-If your contribution has impact on the documentation, please check both version.
+If your contribution has impact on the documentation, please check both version. You can check how to work on the documentation [here](./website/README.md).
 
 ### How to run the documentation website locally
 

Makefile

@@ -45,6 +45,14 @@ watch-relayproxy: ## Launch the relay proxy in watch mode.
 		--build.cmd "go build -mod vendor -o out/bin/relayproxy ./cmd/relayproxy/" \
 		--build.bin "./out/bin/relayproxy"
 
+watch-doc: ## Launch a local server to work on the documentation
+	cd website; \
+    	npm i && npx docusaurus start
+
+serve-doc: ## Serve the doc build by the build-doc target
+	cd website; \
+		npm run serve
+
 swagger: ## Build swagger documentation
 	$(GOCMD) install github.com/swaggo/swag/cmd/swag@latest
 	cd cmd/relayproxy && swag init --markdownFiles docs

website/README.md

@@ -1,41 +1,29 @@
-# Website
+# How to contribute to GO Feature Flag website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.  
 
-### Installation
+You will need to have **nodejs** installed in your machine to work with the documentation website.
 
-```
-$ yarn
-```
-
-### Local Development
-
-```
-$ yarn start
-```
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
-### Build
+## Launch locally
 
-```
-$ yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
+Your can start locally the website.
 
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
+1. Open a terminal and go to the root project of this repository.
+2. Launch the command bellow, it will install the dependencies and run the local server for the documentation.
+```shell
+make watch-doc
 ```
+3. You can now access to the documentation directly in your browser: [http://localhost:3000/](http://localhost:3000/).
 
-Not using SSH:
 
+## Build the documentation
+1. Open a terminal and go to the root project of this repository.
+2. Launch the command bellow, it will install the dependencies and build the documentation.
+```shell
+make build-doc
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+3. If you want to see the result of your build, you can serve it with this command:
+```shell
+make serve-doc
 ```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.