Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for containerized website authoring #494

Merged
merged 2 commits into from
May 20, 2021
Merged

Update docs for containerized website authoring #494

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc6be2f
Update docs for containerized website authoring
May 20, 2021
4be6418
Amended CONTRIBUTING.md with suggested changes
May 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ performs upgrade of k8gb helm chart and controller to the testing version built
- See the [local playground guide](https://github.com/k8gb-io/k8gb/blob/master/docs/local.md) for local testing environment setup and integration test execution.

### Testing against real k8s clusters

There is a possibility to execute the integration terratest suite over the real clusters.
For this, you need to override the set of test settings as in the example below.
```sh
Expand Down Expand Up @@ -184,14 +185,17 @@ Changes to the k8gb.io website layout and styling should be checked out from the
### Local website authoring and testing

These instructions will help you to set up and use local website authoring and testing environment:
- Install Jekyll and Bundler following the [instructions](https://jekyllrb.com/docs/installation/).
- Create dedicated [GitHub Personal Access Token](https://github.com/settings/tokens/new) with `public_repo` permission.
- Run the following command to generate and run the local copy of the k8gb.io website:
- Check-out from the `\gh-pages` branch
- Create dedicated [GitHub Personal Access Token](https://github.com/settings/tokens/new) with `public_repo` permission and assign it to the `JEKYLL_GITHUB_TOKEN` environment variable:
```sh
- Run the following `make` target to build and serve the local copy of the k8gb.io website.
```sh
JEKYLL_GITHUB_TOKEN=<GITHUB_PAT_TOKEN> exec jekyll serve --watch --livereload
make serve
```
where `<GITHUB_PAT_TOKEN>` is the previously generated GitHub PAT token
- Open the `http://127.0.0.1:4000/` page in your browser
*The target utilizes the `jekyll/jekyll` docker container to avoid unnecessary installation of local GitHub page authoring dependencies.*

- Open the `http://localhost:4000/` page in your browser.
- Website will automatically rebuild and refresh in the browser to accommodate the related code changes.

---
Thanks for contributing!