Skip to content

Adjust install steps (#179) #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2022
Merged

Adjust install steps (#179) #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenFunction Website

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

## Contribute

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

#### Pre-requisites

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

### Running the openfunction.dev locally
### Running openfunction.dev locally

After you setup the environment, run the following command:

```
hugo server -D
```

Now you can preview the openfunction.dev in your browser at `http://localhost:1313/`.
Now you can preview openfunction.dev 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 openfunction.dev. Use DCO sign-off when you submit a PR by running the command below (add `-s`):
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`):

```bash
git commit -s -m "xxx"
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,13 @@ For more information about OpenFunction components compatibility with Kubernetes

## Install OpenFunction

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

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

#### install the chart
#### Steps to install OpenFunction helm charts

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

### Option 2: CLI
### Option 2: Install with CLI

1. Run the following command to download `ofn`, the CLI of OpenFunction.

```shell
Expand Down