You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2018/04/27 03:27:57 UTC
[incubator-servicecomb-website] branch master updated (9abf76b ->
d2101ce)
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-website.git.
from 9abf76b Update the chinese verion of release guide
new 192a18e correct chapter 'How to run the site locally' of REAME.md (#72)
new d2101ce SCB-519 Updated the README file
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 39 ++++++++++++++++++++++++++-------------
1 file changed, 26 insertions(+), 13 deletions(-)
--
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.
[incubator-servicecomb-website] 01/02: correct chapter 'How to run
the site locally' of REAME.md (#72)
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-website.git
commit 192a18ec01ff7b586e94dc3d074e17671e8ac3c3
Author: Zen Lin <li...@huawei.com>
AuthorDate: Fri Apr 27 11:09:53 2018 +0800
correct chapter 'How to run the site locally' of REAME.md (#72)
Signed-off-by: linzhinan <li...@huawei.com>
---
README.md | 28 ++++++++++++++++++----------
1 file changed, 18 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 0bea954..0cf7617 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,37 @@
# ServiceComb Website
The Web Site of ServiceComb is based on [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/).
-# How to run the site locally
-* Install [Ruby](https://www.ruby-lang.org/en/downloads/) and [Gem](https://rubygems.org/)
-
-* Install Jekyll and Bundler
-
- `gem install jekyll bundler`
+# How to run the site locally
+* Change to non-root user
+
+* Install [Ruby](https://www.ruby-lang.org/en/downloads/) and [Gem](https://rubygems.org/)
+
+* Install Jekyll and Bundler
+
+ `sudo gem install jekyll bundler`
* Clone the site files
- `git clone git@github.com:ServiceComb/ServiceComb.github.io.git`
+ `git clone https://github.com/apache/incubator-servicecomb-website.git`
* cd ServiceComb.github.io.git
* Install the gems with bundle
- `bundle install`
+ `sudo bundle install`
* Start the jekyll server
- `bundle exec jekyll server`
+ `sudo bundle exec jekyll server`
* Start web browser to access `http://localhost:4000`
-
+
+**Note that tested versions of the tools covered in this section are as following,**
+
+* Ruby 2.3
+* Gem 2.7.6
+* Bundler 2.3
+
# Multiple language support
The website supports English now and English is used as the default language.
--
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.
[incubator-servicecomb-website] 02/02: SCB-519 Updated the README
file
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-website.git
commit d2101ce1fdb31d0ca3da5edd2cfa5453791d33af
Author: Willem Jiang <ji...@huawei.com>
AuthorDate: Fri Apr 27 11:25:21 2018 +0800
SCB-519 Updated the README file
---
README.md | 29 +++++++++++++++++------------
1 file changed, 17 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 0cf7617..cd08f74 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,25 @@
# ServiceComb Website
-The Web Site of ServiceComb is based on [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/).
+The Web Site of ServiceComb is based on [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/).
+
+# NOTE for PR
+As this website is using the [gitpubsub](https://www.apache.org/dev/project-site.html) 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
* Change to non-root user
-
+
* Install [Ruby](https://www.ruby-lang.org/en/downloads/) and [Gem](https://rubygems.org/)
-
+
* Install Jekyll and Bundler
-
+
`sudo gem install jekyll bundler`
* Clone the site files
`git clone https://github.com/apache/incubator-servicecomb-website.git`
-* cd ServiceComb.github.io.git
+* cd incubator-servicecomb-website
* Install the gems with bundle
@@ -25,15 +30,15 @@ The Web Site of ServiceComb is based on [Minimal Mistakes Jekyll Theme](https://
`sudo bundle exec jekyll server`
* Start web browser to access `http://localhost:4000`
-
+
**Note that tested versions of the tools covered in this section are as following,**
-
+
* Ruby 2.3
* Gem 2.7.6
* Bundler 2.3
-
+
# Multiple language support
-The website supports English now and English is used as the default language.
+The website supports English now and English is used as the default language.
Things to be **cautious**:
@@ -44,8 +49,8 @@ There are two language labels: *en* and *cn*.
lang: cn
ref: unique_post_ref_just_like_the_url
```
- And remember to add the prefix **/cn** to your permalink, e.g.
- before:
+ And remember to add the prefix **/cn** to your permalink, e.g.
+ before:
```yml
permalink: /about/me/
```
@@ -53,7 +58,7 @@ There are two language labels: *en* and *cn*.
```yml
permalink: /cn/about/me/
```
- Besides, if contents of your post contains links to the Chinese version of pages, remember to add the
+ Besides, if contents of your post contains links to the Chinese version of pages, remember to add the
prefix **/cn** before the link. e.g. */about/community/* becomes */cn/about/community/*
*Notes*: English Posts do not need to add any prefixes as it's the default language.
2. When you add items in *_data/navigation.yml* file, remember to add both English and Chinese version of that links.
--
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.