Skip to content

Commit bea134f

Browse files
committed
fix: add doc, hide obsolete social links
Signed-off-by: Mark <mlavi@users.noreply.github.com>
1 parent 71d31b5 commit bea134f

File tree

2 files changed

+51
-40
lines changed

2 files changed

+51
-40
lines changed

README.md

+23-13
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11

2-
# Kanister.io web site
2+
# Kanister.io Web Site
33
[![NodeJS with Gulp](https://github.com/kanisterio/website/actions/workflows/npm-gulp.yml/badge.svg)](https://github.com/kanisterio/website/actions/workflows/npm-gulp.yml)
44

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.
87

98
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.
109

@@ -34,28 +33,39 @@ node --version && npm --version && npx --version # confirm versions
3433
npm cache clean --force && rm -rf node_modules package-lock.json kanister.io
3534
```
3635

37-
### Install Node package dependencies
36+
### Install Node Package Dependencies
3837
```shell
3938
npm install
39+
40+
# OPTIONAL: to allow `gulp build`
41+
npm install gulp-cli
4042
```
4143

42-
## Making changes to the web site
44+
## Testing Local Changes
4345
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`.
4446

4547
```bash
4648
npx gulp # executes default target in gulpfile.js
4749

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 &
5352
```
5453

5554
## GitHub Pages
56-
__This is a work in progress!__
5755

5856
Configuration details in:
5957
- [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/)
6163
- [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

Comments
 (0)