|
1 | 1 |
|
2 |
| -# Kanister.io web site |
| 2 | +# Kanister.io Web Site |
3 | 3 | [](https://github.com/kanisterio/website/actions/workflows/npm-gulp.yml)
|
4 | 4 |
|
5 |
| -## Getting started |
6 |
| -### Make sure you have node/npm installed |
7 |
| -Node is the Javascript runtime and includes NPM, the Node Package Manager, which installs all the JS dependencies. |
| 5 | +## Install node/npm |
| 6 | +Node is the Javascript runtime and includes NPM, the Node Package Manager, which installs all the JS library dependencies. |
8 | 7 |
|
9 | 8 | If you have a Mac and use Homebrew, you can install with `brew install node`. Otherwise, see these instructions: https://docs.npmjs.com/getting-started/installing-node.
|
10 | 9 |
|
@@ -34,28 +33,39 @@ node --version && npm --version && npx --version # confirm versions
|
34 | 33 | npm cache clean --force && rm -rf node_modules package-lock.json kanister.io
|
35 | 34 | ```
|
36 | 35 |
|
37 |
| -### Install Node package dependencies |
| 36 | +### Install Node Package Dependencies |
38 | 37 | ```shell
|
39 | 38 | npm install
|
| 39 | + |
| 40 | +# OPTIONAL: to allow `gulp build` |
| 41 | +npm install gulp-cli |
40 | 42 | ```
|
41 | 43 |
|
42 |
| -## Making changes to the web site |
| 44 | +## Testing Local Changes |
43 | 45 | The website is built from source by a build process called [Gulp](https://gulpjs.com/docs/en/getting-started/quick-start). The default build target is `build-kanister`.
|
44 | 46 |
|
45 | 47 | ```bash
|
46 | 48 | npx gulp # executes default target in gulpfile.js
|
47 | 49 |
|
48 |
| -# OPTIONAL: to allow `gulp build` |
49 |
| -npm install gulp-cli |
50 |
| - |
51 |
| -# OPTIONAL: browse the website |
52 |
| -pushd kanister.io && python3 -m http.server & |
| 50 | +# OPTIONAL: browse the website on http://localhost:8000 |
| 51 | +pushd _site && python3 -m http.server & |
53 | 52 | ```
|
54 | 53 |
|
55 | 54 | ## GitHub Pages
|
56 |
| -__This is a work in progress!__ |
57 | 55 |
|
58 | 56 | Configuration details in:
|
59 | 57 | - [pages](https://github.com/kanisterio/website/settings/pages)
|
60 |
| -- [.github/workflows/npm-gulp.yml][https://github.com/kanisterio/website/blob/main/.github/workflows/npm-gulp.yml] |
| 58 | + |
| 59 | +Published with GitHub Actions: |
| 60 | +- [.github/workflows/npm-gulp.yml](https://github.com/kanisterio/website/blob/main/.github/workflows/npm-gulp.yml) |
| 61 | + |
| 62 | + - [Runs](https://github.com/kanisterio/website/actions/) |
61 | 63 | - [environments](https://github.com/kanisterio/website/settings/environments)
|
| 64 | + |
| 65 | + - https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging |
| 66 | + |
| 67 | + ```toml |
| 68 | + # for troubleshooting: |
| 69 | + ACTIONS_RUNNER_DEBUG=true |
| 70 | + ACTIONS_STEP_DEBUG=true |
| 71 | + ``` |
0 commit comments