Apache brpc website

Clone this repo:
  1. ca314c9 Merge pull request #13 from tanzhongyibidu/master by tanzhongyi · 4 weeks ago master
  2. 45cbac2 update README.md to add link for brpc website by tanzhongyibidu · 4 weeks ago
  3. 0d21c30 add link on top nav bar to github doc url by tanzhongyibidu · 4 weeks ago
  4. 8a4b5ad Merge pull request #11 from tanzhongyibidu/master by tanzhongyi · 4 weeks ago
  5. bcd151e update README to add 'how to contribute' by tanzhongyibidu · 4 weeks ago

brpc Website

The Web Site of brpc (http://brpc.apache.org) is based on Apache Website Template.

NOTE for PR

As this website is using the gitpubsub and we use Jekyll to generate the site. We choose master branch to hold all the site source change and asf-site for apache gitpubsub. Please sent your PR to the master branch instead of asf-site.

How to run the site locally

  • Install Ruby and Gem

  • Install Jekyll and Bundler

    sudo gem install jekyll bundler github-pages

  • Clone the site files

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

  • cd incubator-brpc-website

  • Install the gems with bundle

    sudo bundle install

  • Start the jekyll server

    sudo bundle exec jekyll server

  • Start web browser to access http://localhost:4000

How to contribute

  • Checkout the master branch to get the source, run locally
  • Modify and create pull request as usual
  • Switch to asf-site branch, copy the generated html from master branch(it is under target directory), then create pull request for asf-site branch.
  • Wait for brpc.apache.org auto deploy works

Note that tested versions of the tools covered in this section are as following,
(I tested it on Ubuntu)

  • Ruby 2.5
  • Gem 2.7
  • Bundler 2.0