From 8bb625adb7f64d58d8c99a1008eaf0d30f042aa3 Mon Sep 17 00:00:00 2001 From: Rowayda Khayri Date: Mon, 10 Feb 2020 15:54:05 +0200 Subject: [PATCH] Minor readme improvements --- README.md | 20 +++++++++---------- .../contributing/submitting-pull-requests.md | 6 +++--- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index faf283129..628c5c303 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ You can access the simple HTML frontend of Traefik. You can find the complete documentation of Traefik v2 at [https://docs.traefik.io](https://docs.traefik.io). -If you are using Traefik v1, you can find the complete documentation at [https://docs.traefik.io/v1.7/](https://docs.traefik.io/v1.7/) +If you are using Traefik v1, you can find the complete documentation at [https://docs.traefik.io/v1.7/](https://docs.traefik.io/v1.7/). A collection of contributions around Traefik can be found at [https://awesome.traefik.io](https://awesome.traefik.io). @@ -122,7 +122,7 @@ git clone https://github.com/containous/traefik ## Introductory Videos -You can find high level and deep dive videos on [videos.containo.us](https://videos.containo.us) +You can find high level and deep dive videos on [videos.containo.us](https://videos.containo.us). ## Maintainers @@ -138,16 +138,16 @@ By participating in this project, you agree to abide by its terms. ## Release Cycle - We release a new version (e.g. 1.1.0, 1.2.0, 1.3.0) every other month. -- Release Candidates are available before the release (e.g. 1.1.0-rc1, 1.1.0-rc2, 1.1.0-rc3, 1.1.0-rc4, before 1.1.0) -- Bug-fixes (e.g. 1.1.1, 1.1.2, 1.2.1, 1.2.3) are released as needed (no additional features are delivered in those versions, bug-fixes only) +- Release Candidates are available before the release (e.g. 1.1.0-rc1, 1.1.0-rc2, 1.1.0-rc3, 1.1.0-rc4, before 1.1.0). +- Bug-fixes (e.g. 1.1.1, 1.1.2, 1.2.1, 1.2.3) are released as needed (no additional features are delivered in those versions, bug-fixes only). -Each version is supported until the next one is released (e.g. 1.1.x will be supported until 1.2.0 is out) +Each version is supported until the next one is released (e.g. 1.1.x will be supported until 1.2.0 is out). -We use [Semantic Versioning](https://semver.org/) +We use [Semantic Versioning](https://semver.org/). -## Mailing lists +## Mailing Lists -- General announcements, new releases: mail at news+subscribe@traefik.io or on [the online viewer](https://groups.google.com/a/traefik.io/forum/#!forum/news) +- General announcements, new releases: mail at news+subscribe@traefik.io or on [the online viewer](https://groups.google.com/a/traefik.io/forum/#!forum/news). - Security announcements: mail at security+subscribe@traefik.io or on [the online viewer](https://groups.google.com/a/traefik.io/forum/#!forum/security). ## Credits @@ -156,5 +156,5 @@ Kudos to [Peka](http://peka.byethost11.com/photoblog/) for his awesome work on t Traefik's logo is licensed under the Creative Commons 3.0 Attributions license. -Traefik's logo was inspired by the gopher stickers made by Takuya Ueda (https://twitter.com/tenntenn). -The original Go gopher was designed by Renee French (https://reneefrench.blogspot.com/). +Traefik's logo was inspired by the gopher stickers made by [Takuya Ueda](https://twitter.com/tenntenn). +The original Go gopher was designed by [Renee French](https://reneefrench.blogspot.com/). diff --git a/docs/content/contributing/submitting-pull-requests.md b/docs/content/contributing/submitting-pull-requests.md index bb3183f40..1de31241a 100644 --- a/docs/content/contributing/submitting-pull-requests.md +++ b/docs/content/contributing/submitting-pull-requests.md @@ -3,11 +3,11 @@ A Quick Guide for Efficient Contributions {: .subtitle } -So you've decide to improve Traefik? +So you've decided to improve Traefik? Thank You! Now the last step is to submit your Pull Request in a way that makes sure it gets the attention it deserves. -Let's go though the classic pitfalls to make sure everything is right. +Let's go through the classic pitfalls to make sure everything is right. ## Title @@ -36,7 +36,7 @@ Help the readers focus on what matters, and help them understand the structure o - Add tests. - Address review comments in terms of additional commits (and don't amend/squash existing ones unless the PR is trivial). -!!! note "third-party dependencies" +!!! note "Third-Party Dependencies" If a PR involves changes to third-party dependencies, the commits pertaining to the vendor folder and the manifest/lock file(s) should be committed separated.