How to test documentation PR locally ?

[surajnarwade]

It's very difficult to try documentation changes and preview locally, any additional documenation will help.

[concaf]

Do you mean how to test markdown changes locally? There are plugins for IDEs which can help with that.

[cdrage]

You can just push the docs to your branch and view it on GitHub.. for example:

https://github.com/cdrage/kedge/blob/documentation-updates/docs/file-reference.md

[kadel]

@surajnarwade is probably asking how to generate file-reference webpage locally, right?

It is using https://github.com/lord/slate
You can check ./scripts/sync-doc.sh to se how its generated for kedgeproject.org webpage

[cdrage]

@surajnarwade Right now we generate slate using a docker image. Generating the static build:

docker run --rm -v $PWD:/usr/src/app/source -w /usr/src/app/source cdrage/slate bundle exec middleman build --clean

If you run the above command and then: jekyll serve . in the same directory, you should be able to view the docs at localhost:4000

I should add a command within the Makefile for this... probably make serve-docs

[surajnarwade]

@kadel @cdrage cool, thanks :)

[kadel]

can we close this?

[surajnarwade]

@kadel sure