From bea134fc62af63b07512b7f41c76fc14e8fa3a62 Mon Sep 17 00:00:00 2001 From: Mark Date: Wed, 3 Apr 2024 12:54:58 -0500 Subject: [PATCH] fix: add doc, hide obsolete social links Signed-off-by: Mark --- README.md | 36 +++++++++++++-------- app/dist/kanister-io/index.html | 55 +++++++++++++++++---------------- 2 files changed, 51 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 50776f9..e457149 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 + ``` diff --git a/app/dist/kanister-io/index.html b/app/dist/kanister-io/index.html index 0f1ab15..8a92e5e 100644 --- a/app/dist/kanister-io/index.html +++ b/app/dist/kanister-io/index.html @@ -19,21 +19,21 @@ - + - + - + @@ -42,7 +42,7 @@ - + @@ -64,9 +64,9 @@ /> - + -Kanister - An extensible framework for application-level data management on Kubernetes +Kanister - An extensible framework for application data management on Kubernetes @@ -76,7 +76,7 @@ height="0" width="0" style="display:none;visibility:hidden"> - +
@@ -1469,6 +1469,13 @@

Fork us on Github! + + Documentation +

@@ -1495,7 +1502,7 @@
-

Kanister is available as an open-source project today!

+

Join the Kanister Community:

@@ -2693,7 +2701,7 @@
Kanister Blueprint
othercustomaction:
- + @@ -2769,18 +2777,20 @@
Kanister Blueprint
GitHub github.com/kanisterio/kanister - + @kanisterio + Documentation
-
@@ -2797,10 +2807,6 @@
Kanister Blueprint
- - - -
- - - - -