Skip to content
Permalink
Browse files
brpc website 1.0 modify readme
  • Loading branch information
huxiguo authored and huxiguo committed Feb 15, 2022
1 parent 9750f0d commit 564a5900c4ae09c4765c2b7bf095c8339eaa0161
Showing 1 changed file with 34 additions and 1 deletion.
@@ -47,9 +47,42 @@ hugo
We choose master branch to hold all the site source change and asf-site for apache github website.
Please sent your PR to the master branch instead of asf-site.

## How to modify the website pages

The following is the structure of the /content folder in which the files you will mainly modify. Take adding a new committer to the **Community** page and adding a new bRPC release version to **Download bRPC** page as an example, just find the corresponding `index.md` documents in /content folder then modify them. Modifying other files or pages is similar.

```
incubator-brpc-website
- content
| - en
| | - community
| | | - index.md
| | - docs
| | | - DownloadBRPC
| | | | - index.md
| | | - ...
| - zh
| | - community
| | | - index.md
| | - docs
| | | - DownloadBRPC
| | | | - index.md
| | | - ...
```

## Update docs
1. Create new branch
2. Commit and push changes to content
3. Submit pull request to **master** branch
4. Generate static pagas and Submit pull request to **asf-site** branch
5. Staging site will automatically get created and linked to PR to review and test
5. Staging site will automatically get created and linked to PR to review and test

## Trouble shooting

You may encounter the **Piped Failed** problem when you execute the `hugo server` or `hugo` command, the solution is as follows.
``` sh
sudo launchctl limit maxfiles 65535 200000
ulimit -n 65535
sudo sysctl -w kern.maxfiles=100000
sudo sysctl -w kern.maxfilesperproc=65535
```

0 comments on commit 564a590

Please sign in to comment.