https://github.com/openelb/website
https://github.com/openelb/website
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/openelb/website
- Owner: openelb
- License: apache-2.0
- Created: 2020-04-12T13:24:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T01:29:09.000Z (almost 2 years ago)
- Last Synced: 2025-05-06T23:15:16.237Z (about 1 year ago)
- Language: CSS
- Homepage: website-openelb.vercel.app
- Size: 24.4 MB
- Stars: 3
- Watchers: 3
- Forks: 13
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenELB Website
Welcome to the OpenELB website repository!
This repository contains web pages of the [official OpenELB website](https://openelb.io), including documentation, blog articles, community information, and other contents of the [OpenELB open-source project](https://github.com/kubesphere/OpenELB).
Whether you are a tech enthusiast, a language professional, or simply someone interested in the OpenELB project, you are always welcome to send your works to the OpenELB website and help localize the website!
## Localize the OpenELB Website
We are currently looking for people to localize the website. If you have passion for localization, please [send Pull Requests](#send-pull-requests) to this repository.
* Before you start working, please read the [OpenELB Chinese Documentation Style Guide](./OpenELB-chinese-documentation-style-guide.md).
* All documents of the OpenELB website are stored in the `/content` directory.
* If you need to insert an image in a document, save the image in a directory named after the document in the `/static/images/zh` directory and reference the image by using the following expression (change everything in `<>` to actual values):
```bash
```
Don't worry if the images are not correctly displayed in your editor. They will be correctly parsed by the website.
## Send Pull Requests
If you have documents, blog articles, or localization works for the OpenELB project, please send pull requests to this repository.
Step 1: Create a GitHub account and set up a local OpenELB website repository.
1. Create a [GitHub account](https://github.com/join).
2. In the [OpenELB website repository](https://github.com/kubesphere/porter-website), click 
in the upper-right corner to fork this repository to your own GitHub account.
3. In your local command-line interface (CLI), run the following commands to clone the OpenELB website repository and go to the `porter-website` directory.
```bash
git clone
```
```bash
cd website
```
4. Run the following command to set the upstream address:
```bash
git remote add upstream https://github.com/openelb/website.git
```
Step 2: Add your work and push it to GitHub.
1. Run the following command to synchronize your local repository with the upstream:
```bash
git pull --rebase upstream master
```
2. Run the following command to create a branch and switch to the branch:
```bash
git switch -c
```
3. Use your favorite editor (such as [Typora](https://typora.io/)) to add contents to or edit existing contents in the `/content` directory.
Step 3: Preview your work in your local environment.
1. [Install Hugo](https://gohugo.io/getting-started/quick-start/) in your local environment.
2. Go to the `porter-website` directory and run the following command:
```bash
hugo server -D
```
3. Open a web browser and enter `http://localhost:1313` in the address box to preview your work.
Step 4: Commit your changes and create a pull request.
1. Run the following commands to commit your changes and push it to your own repository on GitHub:
```bash
git add .
```
```bash
git commit -s -m ""
```
```bash
git push -u origin
```
2. Visit the [OpenELB website repository](https://github.com/kubesphere/porter-website), click **Pull requests**, and click **Compare & pull request**.
3. Add `/assign @Patrick-LuoYu @FeynmanZhou @renyunkang` in the text box to assign the three guys to review your work.
4. Click **Create pull request**. After your work is reviewed, it will be merged into the repository and become available to users around the world.
5. In your local CLI, run the following command to switch to the master branch. Repeat Step 2 to Step 4 each time you have something new for the OpenELB website.
```bash
git switch master
```
## Contact Us
Join us at the [Slack #sig-docs channel](https://kubesphere.slack.com/archives/C010WA9EW01)!
[](https://vercel.com?utm_source=openelb&utm_campaign=oss)