You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by sj...@apache.org on 2020/06/11 02:39:35 UTC
[flink-web] 01/02: Syncing the ZH version of the Docs Style Guide
with recent changes and correcting an additional point.
This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/flink-web.git
commit d60d1296a8e02917ecb70f03fa57d97d2d0f7005
Author: Marta Paes Moreira <ma...@gmail.com>
AuthorDate: Wed Jun 10 10:07:18 2020 +0200
Syncing the ZH version of the Docs Style Guide with recent changes and correcting an additional point.
---
contributing/docs-style.md | 2 +-
contributing/docs-style.zh.md | 8 +++-----
2 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/contributing/docs-style.md b/contributing/docs-style.md
index a7c79be..d016d00 100644
--- a/contributing/docs-style.md
+++ b/contributing/docs-style.md
@@ -82,7 +82,7 @@ opening a pull-request.
## Repository
Markdown files (.md) should have a short name that summarizes the topic
-covered, spelled in **lowercase** and with **underscores** separating the
+covered, spelled in **lowercase** and with **dashes (-)** separating the
words. The Chinese version file should have the same name as the English
version, but suffixed with **.zh.md**.
diff --git a/contributing/docs-style.zh.md b/contributing/docs-style.zh.md
index a39f6df..d016d00 100644
--- a/contributing/docs-style.zh.md
+++ b/contributing/docs-style.zh.md
@@ -82,7 +82,7 @@ opening a pull-request.
## Repository
Markdown files (.md) should have a short name that summarizes the topic
-covered, spelled in **lowercase** and with **underscores** separating the
+covered, spelled in **lowercase** and with **dashes (-)** separating the
words. The Chinese version file should have the same name as the English
version, but suffixed with **.zh.md**.
@@ -336,13 +336,11 @@ overwriting.
[Link Text](#heading-title)
```
-* **Links to other pages of the Flink documentation.** The base relative path
- to the domain of the documentation is available as a configuration variable
- named `baseurl`.
+* **Links to other pages of the Flink documentation.**
{% raw %}
```liquid
- [Link Text]({{ site.baseurl }}{% link path/to/link-page.md %})
+ [Link Text]({% link path/to/link-page.md %})
```
{% endraw %}