# incubator-brpc-website

**Repository Path**: mirrors_apache/incubator-brpc-website

## Basic Information

- **Project Name**: incubator-brpc-website
- **Description**: Apache bRPC Website
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2025-10-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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

## Overview

The Apache bRPC Website are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme.
This project contains the hugo project, markdown files, and theme configurations.

## Pre-requisites

- [Hugo extended version](https://gohugo.io/getting-started/installing)
- [Node.js](https://nodejs.org/en/)

## Environment setup

Install pre-requisites
```sh
$ sudo apt install npm
$ npm install
```

## Run local server


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

5. If you want to generate the static pages in /public folder, just run
```sh
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.

```
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.
``` sh
sudo launchctl limit maxfiles 65535 200000
ulimit -n 65535
sudo sysctl -w kern.maxfiles=100000
sudo sysctl -w kern.maxfilesperproc=65535
```