https://github.com/kubesphere/dev-guide
A set of development guidelines for KubeSphere developers.
https://github.com/kubesphere/dev-guide
Last synced: over 1 year ago
JSON representation
A set of development guidelines for KubeSphere developers.
- Host: GitHub
- URL: https://github.com/kubesphere/dev-guide
- Owner: kubesphere
- License: apache-2.0
- Created: 2022-04-21T07:08:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T02:24:37.000Z (over 2 years ago)
- Last Synced: 2024-04-13T21:43:06.986Z (over 2 years ago)
- Language: HTML
- Homepage: https://dev-guide.kubesphere.io
- Size: 16.6 MB
- Stars: 19
- Watchers: 25
- Forks: 34
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KubeSphere Dev Guide
This project uses [Hugo](https://gohugo.io/) and [Hugo theme learn](https://github.com/matcornic/hugo-theme-learn) to build the website.
[](https://app.netlify.com/sites/kubesphere-dev-guide/deploys)
## Contribute
Contributions of any kind are welcome!
### Fork and clone the repository
1. Fork the repository.
2. Run the following commands to clone your fork. Make sure you replace `` with your GitHub ID.
```bash
git clone https://github.com//dev-guide.git
cd dev-guide
```
### Build and preview the website
You'll need to install [Hugo](https://gohugo.io/) to build the website before you can **preview it**.
#### Install Hugo extended
Go to the [Hugo releases page](https://github.com/gohugoio/hugo/releases) and download the `hugo_extended` version that suits your OS (version 0.75+).
**EXTENDED version is MANDATORY to properly build the static content!**
Note: If you install Hugo on Windows, you need to add environment variables for the .exe file of Hugo. Run `hugo version` to check if the installation is successful.
### Running the website locally
After you install Hugo, run the following command:
```bash
# Launch KubeSphere extension development guide
make extension-dev-guide
```
or
```bash
# Launch KubeSphere development guide
make dev-guide
```
Now you can preview the website in your browser at `http://localhost:1313/`.
### Open a pull request
Open a [pull request (PR)](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request#creating-a-new-pull-request) to contribute to our website. Use DCO sign-off when you submit a PR by running the command below (add `-s`):
```bash
git commit -s -m "xxx"
```
## Contributors
Thanks to all the wonderful contributors who continue to evolve KubeSphere within a great community.
