Skip to content

Commit

Permalink
fix: add doc, hide obsolete social links
Browse files Browse the repository at this point in the history
Signed-off-by: Mark <[email protected]>
  • Loading branch information
mlavi committed Apr 3, 2024
1 parent 71d31b5 commit bea134f
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 40 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@

# Kanister.io web site
# Kanister.io Web Site
[![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)

## Getting started
### Make sure you have node/npm installed
Node is the Javascript runtime and includes NPM, the Node Package Manager, which installs all the JS dependencies.
## Install node/npm
Node is the Javascript runtime and includes NPM, the Node Package Manager, which installs all the JS library dependencies.

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.

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

### Install Node package dependencies
### Install Node Package Dependencies
```shell
npm install

# OPTIONAL: to allow `gulp build`
npm install gulp-cli
```

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

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

# OPTIONAL: to allow `gulp build`
npm install gulp-cli

# OPTIONAL: browse the website
pushd kanister.io && python3 -m http.server &
# OPTIONAL: browse the website on http://localhost:8000
pushd _site && python3 -m http.server &
```

## GitHub Pages
__This is a work in progress!__

Configuration details in:
- [pages](https://github.com/kanisterio/website/settings/pages)
- [.github/workflows/npm-gulp.yml][https://github.com/kanisterio/website/blob/main/.github/workflows/npm-gulp.yml]

Published with GitHub Actions:
- [.github/workflows/npm-gulp.yml](https://github.com/kanisterio/website/blob/main/.github/workflows/npm-gulp.yml)

- [Runs](https://github.com/kanisterio/website/actions/)
- [environments](https://github.com/kanisterio/website/settings/environments)

- https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging

```toml
# for troubleshooting:
ACTIONS_RUNNER_DEBUG=true
ACTIONS_STEP_DEBUG=true
```
Loading

0 comments on commit bea134f

Please sign in to comment.