Skip to content

Commit 9b97463

Browse files
authored
Adjust install steps (#179)
Signed-off-by: Benjamin Huo <benjamin@kubesphere.io>
1 parent 50c0e78 commit 9b97463

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenFunction Website
22

3-
This project uses [Hugo](https://gohugo.io/) and [Hugo template Docsy](https://github.com/google/docsy) to build the OpenFunction website.
3+
openfunction.dev is OpenFunction's website which is built with [Hugo](https://gohugo.io/) and [Hugo template Docsy](https://github.com/google/docsy).
44

55
## Contribute
66

@@ -16,7 +16,7 @@ Contributions of any kind are welcome!
1616
git clone https://github.com/<Your GitHub ID>/openfunction.dev.git
1717
cd openfunction.dev
1818
```
19-
### Build and preview the openfunction.dev
19+
### Build and preview openfunction.dev
2020

2121
#### Pre-requisites
2222

@@ -32,19 +32,19 @@ Contributions of any kind are welcome!
3232
1. Update submodules: `git submodule update --init --recursive`
3333
1. Install npm packages: `npm install`
3434

35-
### Running the openfunction.dev locally
35+
### Running openfunction.dev locally
3636

3737
After you setup the environment, run the following command:
3838

3939
```
4040
hugo server -D
4141
```
4242

43-
Now you can preview the openfunction.dev in your browser at `http://localhost:1313/`.
43+
Now you can preview openfunction.dev in your browser at `http://localhost:1313/`.
4444

4545
### Open a pull request
4646

47-
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 openfunction.dev. Use DCO sign-off when you submit a PR by running the command below (add `-s`):
47+
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 openfunction.dev. Use DCO sign-off when you submit a PR by running the command below (add `-s`):
4848

4949
```bash
5050
git commit -s -m "xxx"

content/en/docs/getting-started/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,13 @@ For more information about OpenFunction components compatibility with Kubernetes
3333

3434
## Install OpenFunction
3535

36-
### Option 1: Helm
37-
This option is the **recommended** installation method.
36+
### Option 1: Install with helm chart (recommended)
3837

3938
#### Requirements
4039
- Kubernetes version: `>=v1.20.0-0`
4140
- Helm version: `>=v3.6.3`
4241

43-
#### install the chart
42+
#### Steps to install OpenFunction helm charts
4443

4544
1. Run the following command to add the OpenFunction chart repository first:
4645
```shell
@@ -85,7 +84,8 @@ This option is the **recommended** installation method.
8584
kubectl get pods -namespace openfunction
8685
```
8786

88-
### Option 2: CLI
87+
### Option 2: Install with CLI
88+
8989
1. Run the following command to download `ofn`, the CLI of OpenFunction.
9090

9191
```shell

0 commit comments

Comments
 (0)