Skip to content

Commit

Permalink
changed the readme.md and contributing.md file (#922)
Browse files Browse the repository at this point in the history
* changed the readme.md and contributing.md file and removed recurse-submodule option

Signed-off-by: brf153 <153hsb@gmail.com>

* done with readme.md and contributing.md file

Signed-off-by: brf153 <153hsb@gmail.com>

---------

Signed-off-by: brf153 <153hsb@gmail.com>
  • Loading branch information
brf153 authored Jul 19, 2023
1 parent 6a05ade commit 2eb5553
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Head over to project repository on GitHub and click the **"Fork"** button. With
To clone this repository, copy the link of below, paste it in your device terminal and replace the _YOUR-GITHUB-ID_ with your GitHub ID.

```
$ git clone https://github.com/{YOUR-GITHUB-ID}/website kyverno-website/ --recurse-submodules
$ git clone https://github.com/{YOUR-GITHUB-ID}/website kyverno-website/
```

Expand All @@ -78,9 +78,11 @@ Then navigate to the local folder and build the website for local viewing of cha
cd kyverno-website


hugo server -v
hugo server

```
**Note For Windows Users:** When running the `hugo server` command, make sure to execute it with administrator privileges in your terminal. This is necessary to ensure proper access and functionality during the server execution.


5. **Stage, Commit and Push changes:**

Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To contribute changes, use the [fork & pull](https://movi.hashnode.dev/how-to-su

1\. First create a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the Kyverno website repository to your GitHub account. By default, the forked repository will be named `website` but can be changed in the settings for your repository if desired. You will later created a PR (pull request) using this fork.

2\. Next, create a local clone with the `--recurse-submodules` option:
2\. Next, create a local clone using the command:

```sh
git clone https://github.com/{YOUR-GITHUB-ID}/website kyverno-website/
Expand All @@ -28,8 +28,9 @@ git clone https://github.com/{YOUR-GITHUB-ID}/website kyverno-website/

```sh
cd kyverno-website
hugo server -v
hugo server
```
**Note For Windows Users:** When running the `hugo server` command, make sure to execute it with administrator privileges in your terminal. This is necessary to ensure proper access and functionality during the server execution.

By default, Hugo runs the website at: http://localhost:1313 and will re-build the site on changes.

Expand Down

0 comments on commit 2eb5553

Please sign in to comment.