https://github.com/replicatedhq/kurl.sh
https://github.com/replicatedhq/kurl.sh
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/replicatedhq/kurl.sh
- Owner: replicatedhq
- Created: 2019-09-09T23:18:43.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-11T17:58:58.000Z (7 months ago)
- Last Synced: 2024-12-11T18:33:47.112Z (7 months ago)
- Language: JavaScript
- Homepage: https://kurl.sh
- Size: 6.78 MB
- Stars: 11
- Watchers: 21
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# kurl.sh
## Local development
Before you are able to run this locally you need to have NodeJS above v.8.12.
1. Install project dependencies
```bash
yarn install
```
1. And then run the project
```bash
make serve
```
1. In your browser navigate to `localhost:8072` to view the project.
2. Local Forward port in VS Code from 8072 to localhost
## Updating documentation flags
1. When updating add-ons flags JSON should be updated (`/static/versionDetails.json`).
2. In a markdown file those flags should be called as `flags-table`.
## Releasing the documentation
The [deploy workflow](https://github.com/replicatedhq/kurl.sh/actions/workflows/deploy.yaml) is responsible for releasing to both staging and production.
Staging will be released on merge to main.
Releasing to the production environment requires review from the @replicatedhq/embedded-kubernetes team.