bRPC Official Website

This project keeps all sources used for building up bRPC official website which's served at https://brpc.apache.org.

Overview

The Apache bRPC docs are built using Hugo with the Docsy theme. This project contains the hugo project, markdown files, and theme configurations.

Pre-requisites

Environment setup

Install pre-requisites

$ sudo apt install npm
$ npm install

Run local server

  1. Clone this repository
git clone https://github.com/apache/incubator-brpc-website.git
  1. Change to root directory:
cd incubator-brpc-website
  1. Run
hugo server
  1. Navigate to http://localhost:1313

  2. If you want to generate the static pages in /public folder, just run

hugo

Note for PR

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 structure of /content folder is as follows in which the files you will mainly modify. Take adding a new committer info to the Community page and adding a new bRPC release version info to Download bRPC page as an example, just find the index.md documents in their corresponding subfolder of /content then modify them. Or just click the Edit this page/编辑本页 button on their pages and modify them directly. Modifying other files or pages is similar.

incubator-brpc-website
- content
| - en
| | - docs
| | | - community
| | | | - index.md
| | | - DownloadBRPC
| | | | - index.md
| | | - ...
| - zh
| | - docs
| | | - community
| | | | - index.md
| | | - 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

Trouble shooting

You may encounter the Piped Failed problem when you execute the hugo server or hugo command, the solution is as follows.

sudo launchctl limit maxfiles 65535 200000
ulimit -n 65535
sudo sysctl -w kern.maxfiles=100000
sudo sysctl -w kern.maxfilesperproc=65535