docs: add documentation for testing docs related changes #58
Conversation
Signed-off-by: Roaa Sakr <[email protected]>
Signed-off-by: Roaa Sakr <[email protected]>
Signed-off-by: Roaa Sakr <[email protected]>
| @@ -0,0 +1,47 @@ | |||
| # Testing github pages locally | |||
There was a problem hiding this comment.
nit: # Testing GitHub Pages Locally with Jekyll
|
|
||
| * Install dependencies | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Tab in (2 spaces). Otherwise, you are breaking the list.
|
|
||
| ```bash | ||
| cat <<EOF > Gemfile | ||
| source "https://rubygems.org" |
There was a problem hiding this comment.
Any reason you aren’t including this file in the repo?
There was a problem hiding this comment.
Didn't want it to interfere with what the github workflow autogenerates.
My guess is we get version upgrades.. etc for free with the workflow and would be good to keep it as is.
| bundle install | ||
| ``` | ||
|
|
||
| * Update `_config.yml` |
There was a problem hiding this comment.
The Jekyll command line allows you to specify multiple config files, with later config files overriding values of earlier config files. Could this be used to avoid needing to temporarily modify the _config.yml file?
|
|
||
| * Install dependencies | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Specify the distro+version this is applicable to. Also, if these tools are available in Azure Linux, it would be to provide steps for that as well.
Checklist