apache / incubator-brpc-website

Apache bRPC Website

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 with the Docsy theme. This project contains the hugo project, markdown files, and theme configurations.

Pre-requisites

• Hugo extended version
• Node.js

Environment setup

Install pre-requisites

$ sudo apt install npm
$ npm install

Run local server

1. Clone this repository

git clone https://github.com/apache/brpc-website.git

2. Change to root directory:

cd brpc-website

3. Run

hugo server

4. Navigate to http://localhost:1313

5. 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.

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

incubator-brpc-website's Issues

bRPC下载地址改为https://brpc.apache.org/download前缀

目前的下载地址是：https://brpc.apache.org/docs/downloadbrpc/

修正外部资源引用问题

Site Check For Podling: https://whimsy.apache.org/pods/project/brpc

$ git grep 'www.google-analytics.com'
themes/docsy/assets/vendor/bootstrap/site/_includes/header.html:37:<script async src='https://www.google-analytics.com/analytics.js'></script>
$ git grep cdnjs.cloudflare.com
themes/docsy/assets/vendor/bootstrap/_config.yml:58:  popper:           "https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js"
themes/docsy/assets/vendor/bootstrap/site/docs/4.1/examples/dashboard/index.html:272:    <script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.7.1/Chart.min.js"></script>
themes/docsy/layouts/partials/scripts.html:2:<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
$ git grep stackpath.bootstrapcdn.com
themes/docsy/assets/vendor/bootstrap/_config.yml:52:  css:              "https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css"
themes/docsy/assets/vendor/bootstrap/_config.yml:54:  js:               "https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js"
themes/docsy/layouts/partials/scripts.html:3:<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>

都是使用的主题中默认带的链接, 需要检查修正.

[DOC] add documents about full polling thread

After repeatedly watching https://www.bilibili.com/video/BV1VN4y1V7jV/?spm_id_from=333.788 and https://www.bilibili.com/video/BV1PG411b7eE/?spm_id_from=333.788, I still can't understand the thread model of full polling, and no relevant documents have been found on the brpc official website. Is there any master can add it ?

开始

sudo apt-get install -y cmake libgtest-dev && cd /usr/src/gtest && sudo cmake . && sudo make && sudo mv libgtest* /usr/lib/ && cd -
需要替换成
sudo apt-get install -y cmake libgtest-dev && cd /usr/src/gtest && sudo cmake . && sudo make && sudo mv lib/libgtest* /usr/lib/ && cd -

Sync RDMA docs and update home page

Basics- pthread mode description is ambiguous

https://brpc.apache.org/docs/server/basics/#pthread-mode

User code(client-side done, server-side CallMethod) runs in bthreads with 1MB stacksize by default. But some of them cannot run in bthreads:

......
brpc offers pthread mode to solve the issues. When -usercode_in_pthread is turned on, user code will be run in pthreads. Functions that would block bthreads block pthreads.

Note: With -usercode_in_pthread on, brpc::thread_local_data() does not guarantee to return valid value.

Performance issues when pthread mode is on:
.....

User code still runs in special bthreads actually, which use stacks of pthread workers. These special bthreads are scheduled same with normal bthreads and performance differences are negligible.

Execution Queue

页面超链接无法正常跳转

1， [多线程向同一个fd写数据](https://brpc.apache.org/docs/bthread/execution-queue/io.md#%E5%8F%91%E6%B6%88%E6%81%AF）

2， contention profiler

包括但不限于以上两个链接 按照深度搜索顺序看文档的所以速度比较慢

IOBuf

文档中介绍IOBuf的原文： “可以拷贝，修改拷贝不影响原IOBuf。拷贝的是IOBuf的管理结构而不是数据。 ”
拷贝的是管理数据，是不是可以理解为浅拷贝，共享底层数据，那么怎么会不影响原IOBuf？

支持新协议，这里PRPC 实际是BRPC意思？是笔误吗？

第一类协议：标记或特殊字符在最前面，比如baidu_std，hulu_pbrpc的前4个字符分别是PRPC和HULU，

这里PRPC 实际是BRPC意思？是笔误吗？

Does `more processes` describe incorrectly?

In https://brpc.apache.org/docs/rpc-in-depth/threading-overview/#n1-threading-library :

N:1 threading libraries perform as well as event-loop libraries and are also scaled by deploying more processes in general.

I think it should be adjusted as follows :

N:1 threading libraries perform as well as event-loop libraries and are also scaled by using more threads in general.

[type: new feature] add CI/CD workflows

refer to https://github.com/apache/shenyu-website/tree/main/.github