Fix whitespaces #2075

chulkilee · 2017-09-06T17:32:21Z

use LF for new line
remove trailing whitespaces, except two spaces at EOL in markdown
add missing new line at the end of file

chulkilee · 2017-09-06T17:38:10Z

I think it would be better to have this one-time large commit than having individual commit with whitespaces changes on irrelevant parts.

dtomcej · 2017-09-06T18:10:26Z

How does this interact with our linters?

Is this something that we can add to our code cleaning tools to do automatically?

ldez · 2017-09-06T18:25:30Z

docs/basics.md

@@ -132,10 +132,10 @@ For instance, `PathPrefix: /products` would match `/products` but also `/product
 Since the path is forwarded as-is, your backend is expected to listen on `/products`.

 Use a `*Strip` matcher if your backend listens on the root path (`/`) but should be routeable on a specific prefix.
-For instance, `PathPrefixStrip: /products` would match `/products` but also `/products/shoes` and `/products/shirts`.  


2 spaces have a meaning in markdown.

When you do want to insert a
break tag using Markdown, you end a line with two or more spaces, then type return.
https://daringfireball.net/projects/markdown/syntax#p

Oh I didn't know that. Then here are options:

keep the two spaces at EOL

replace the two spaces at EOL with <br>

replace the two spaces at EOL with \n\n to separate paragraphs

use different formatting, such as !!! note or lists

I still don't like the significant trailing spaces since it's very easy to mess up. I think using <br> is better if <br> is really needed. Otherwise, the best option is to avoid <br> at all - use separate paragraphs or other formatting.

Let me know - I'll make changes in this PR accordingly.

keep the two spaces at EOL

ldez · 2017-09-06T18:25:47Z

docs/basics.md

@@ -132,10 +132,10 @@ For instance, `PathPrefix: /products` would match `/products` but also `/product
 Since the path is forwarded as-is, your backend is expected to listen on `/products`.

 Use a `*Strip` matcher if your backend listens on the root path (`/`) but should be routeable on a specific prefix.
-For instance, `PathPrefixStrip: /products` would match `/products` but also `/products/shoes` and `/products/shirts`.  
-Since the path is stripped prior to forwarding, your backend is expected to listen on `/`.  


ldez · 2017-09-06T18:25:49Z

docs/basics.md

@@ -132,10 +132,10 @@ For instance, `PathPrefix: /products` would match `/products` but also `/product
 Since the path is forwarded as-is, your backend is expected to listen on `/products`.

 Use a `*Strip` matcher if your backend listens on the root path (`/`) but should be routeable on a specific prefix.
-For instance, `PathPrefixStrip: /products` would match `/products` but also `/products/shoes` and `/products/shirts`.  
-Since the path is stripped prior to forwarding, your backend is expected to listen on `/`.  
-If your backend is serving assets (e.g., images or Javascript files), chances are it must return properly constructed relative URLs.  


ldez · 2017-09-06T18:25:53Z

docs/basics.md

-For instance, `PathPrefixStrip: /products` would match `/products` but also `/products/shoes` and `/products/shirts`.  
-Since the path is stripped prior to forwarding, your backend is expected to listen on `/`.  
-If your backend is serving assets (e.g., images or Javascript files), chances are it must return properly constructed relative URLs.  
-Continuing on the example, the backend should return `/products/shoes/image.png` (and not `/images.png` which Traefik would likely not be able to associate with the same backend).  


ldez · 2017-09-06T18:25:57Z

docs/basics.md

@@ -208,7 +208,7 @@ Finally, you can create a rule to bind multiple domains or Path to a frontend, u

 #### Rules Order

-When combining `Modifier` rules with `Matcher` rules, it is important to remember that `Modifier` rules **ALWAYS** apply after the `Matcher` rules.  


ldez · 2017-09-06T18:26:02Z

docs/basics.md

@@ -355,7 +355,7 @@ requests periodically carried out by Traefik. The check is defined by a path
 appended to the backend URL and an interval (given in a format understood by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration)) specifying how
 often the health check should be executed (the default being 30 seconds).
 Each backend must respond to the health check within 5 seconds.
-By default, the port of the backend server is used, however, this may be overridden.  


There is no following lines after this line - this is the end of the paragraph. So I think it's okay to remove two spaces here.

ldez · 2017-09-06T18:27:11Z

docs/configuration/backends/dynamodb.md


 - `id` (string): The id is the primary key.
 - `name`(string): The name is used as the name of the frontend or backend.
- `frontend` or `backend` (map): This attribute's structure matches exactly the structure of a Frontend or Backend type in traefik.  
-    See `types/types.go` for details.  


ldez · 2017-09-06T18:27:16Z

docs/configuration/backends/dynamodb.md


 - `id` (string): The id is the primary key.
 - `name`(string): The name is used as the name of the frontend or backend.
- `frontend` or `backend` (map): This attribute's structure matches exactly the structure of a Frontend or Backend type in traefik.  


ldez

LGTM

juliens

LGTM

nmengin

LGTM 📖

- use LF for new line - remove trailing whitespaces, except two spaces at EOL in markdown - add missing new line at the end of file

chulkilee requested review from a team as code owners September 6, 2017 17:32

traefiker added area/acme area/infrastructure area/provider/boltdb area/provider/consul area/provider/docker area/provider/etcd area/provider/k8s/ingress area/provider/marathon area/provider/rancher area/webui size/M status/0-needs-triage labels Sep 6, 2017

ldez suggested changes Sep 6, 2017

View reviewed changes

traefiker added the contributor/waiting-for-corrections label Sep 6, 2017

ldez added area/documentation area/provider status/2-needs-review and removed area/provider/boltdb area/provider/consul area/provider/docker area/provider/etcd area/provider/k8s/ingress area/provider/marathon area/provider/rancher labels Sep 6, 2017

ldez removed area/webui status/0-needs-triage labels Sep 6, 2017

ldez modified the milestone: 1.4 Sep 6, 2017

ldez removed area/infrastructure contributor/waiting-for-corrections labels Sep 6, 2017

ldez approved these changes Sep 7, 2017

View reviewed changes

juliens approved these changes Sep 7, 2017

View reviewed changes

nmengin approved these changes Sep 7, 2017

View reviewed changes

traefiker approved these changes Sep 7, 2017

View reviewed changes

ldez added status/3-needs-merge and removed status/2-needs-review labels Sep 7, 2017

traefiker added the status/4-merge-in-progress label Sep 7, 2017

Fix whitespaces

d22b076

- use LF for new line - remove trailing whitespaces, except two spaces at EOL in markdown - add missing new line at the end of file

traefiker removed the status/4-merge-in-progress label Sep 7, 2017

traefiker merged commit 8c55146 into traefik:v1.4 Sep 7, 2017

traefiker removed the status/3-needs-merge label Sep 7, 2017

chulkilee deleted the fix-whitespace branch October 29, 2022 00:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix whitespaces #2075

Fix whitespaces #2075

chulkilee commented Sep 6, 2017 •

edited

Loading

chulkilee commented Sep 6, 2017

dtomcej commented Sep 6, 2017

ldez Sep 6, 2017

chulkilee Sep 6, 2017

ldez Sep 6, 2017

ldez Sep 6, 2017

ldez Sep 6, 2017

ldez Sep 6, 2017

ldez Sep 6, 2017

ldez Sep 6, 2017

chulkilee Sep 6, 2017

ldez Sep 6, 2017

ldez Sep 6, 2017

ldez left a comment

juliens left a comment

nmengin left a comment

		@@ -208,7 +208,7 @@ Finally, you can create a rule to bind multiple domains or Path to a frontend, u

		#### Rules Order

		When combining `Modifier` rules with `Matcher` rules, it is important to remember that `Modifier` rules ALWAYS apply after the `Matcher` rules.

Fix whitespaces #2075

Fix whitespaces #2075

Conversation

chulkilee commented Sep 6, 2017 • edited Loading

chulkilee commented Sep 6, 2017

dtomcej commented Sep 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ldez left a comment

Choose a reason for hiding this comment

juliens left a comment

Choose a reason for hiding this comment

nmengin left a comment

Choose a reason for hiding this comment

chulkilee commented Sep 6, 2017 •

edited

Loading