KubeSphere Dev Guide
This project uses Hugo and Hugo theme learn to build the website.
Contribute
Contributions of any kind are welcome!
Fork and clone the repository
-
Fork the repository.
-
Run the following commands to clone your fork. Make sure you replace
<Your GitHub ID>
with your GitHub ID.git clone https://github.com/<Your GitHub ID>/dev-guide.git cd dev-guide
Build and preview the website
You'll need to install Hugo to build the website before you can preview it.
Install Hugo extended
Go to the Hugo releases page 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:
# Launch KubeSphere extension development guide
hugo server --config extension-dev-guide.toml
or
# Launch KubeSphere development guide
hugo server --config dev-guide.toml
Now you can preview the website in your browser at http://localhost:1313/
.
Open a pull request
Open a pull request (PR) to contribute to our website. Use DCO sign-off when you submit a PR by running the command below (add -s
):
git commit -s -m "xxx"
Contributors
Thanks to all the wonderful contributors who continue to evolve KubeSphere within a great community.