From 922332e33e9205bdc7f245e4c13050ba91ea5d91 Mon Sep 17 00:00:00 2001 From: Sherlock113 Date: Sun, 27 Sep 2020 10:00:58 +0800 Subject: [PATCH] Update readme Signed-off-by: Sherlock113 --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec62332a7..1d759ace8 100644 --- a/README.md +++ b/README.md @@ -75,13 +75,27 @@ Now you can preview the website in your browser using `http://localhost:1313/`. ### Open a pull request -Open a [pull request (PR)](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request#creating-a-new-pull-request) to add a localization to the repository. +Open a [pull request (PR)](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request#creating-a-new-pull-request) to add a localization to the repository. Please use DCO sign-off when you submit a pr. Refer to the command below (add `-s`): + +```bash +git commit -s -m "xxx" +``` + +### Preview a pull request + +Click **Details** as shown in the image below, which will direct you to the website homepage. Navigate to the part you want to preview. + +![](https://ap3.qingstor.com/kubesphere-website/docs/preview-pr-github.png) + +If the button above does not appear, go to **Files changed** tab. Click the three dots of the md file you want to preview as shown below. Please note that this method can only give you a preview on the GitHub instead of on the website. + +![view-file](https://ap3.qingstor.com/kubesphere-website/docs/view-file-github.png) ## Localizing ### Find your two-letter language code -First, find your localization’s two-letter country code. For example, the two-letter code for Turkey is tr. then, open `config.toml`, change the menu which language you want to translate。 +First, find your localization’s two-letter country code. For example, the two-letter code for Turkey is tr. Then, open `config.toml` and change the menu of the language you want to translate. ``` [languages.tr]