traefik: add page #1512
traefik: add page #1512
Conversation
Adds the page for Traefik as requested on tldr-pages#1184
pages/common/traefik.md
Outdated
| @@ -0,0 +1,19 @@ | |||
| # traefik | |||
|
|
|||
| > Traefik HTTP reverse proxy and load balance. | |||
There was a problem hiding this comment.
No need to mention traefik again in the heading. Also typo in balance.
I suggest - A HTTP reverse proxy and load balancer
pages/common/traefik.md
Outdated
|
|
||
| `traefik --c {{config_file}}.toml` | ||
|
|
||
| - Start server with a cluster mode enabled: |
pages/common/traefik.md
Outdated
|
|
||
| `traefik --cluster` | ||
|
|
||
| - Start server with web ui enabled: |
There was a problem hiding this comment.
ui => UI.
Also, the words "Start server" are kinda getting repetitive. Maybe you can just say "Enable web UI".
There was a problem hiding this comment.
- I think it's important to dictate that the flag I'm referring to, both starts the Traefik server and enables the UI. While it's true that all of my items start the server, it's worth ensuring there is no confusion of altering a configuration to enable the web UI. It's a pretty short list, but a couple flags do not actually start the server.
- This mirrors the same language on the nginx page. Nginx is pretty similar in terms of having a small number of args that don't start the server.
There was a problem hiding this comment.
It's a pretty short list, but a couple flags do not actually start the server.
I see. Okay then.
|
|
||
| > A HTTP reverse proxy and load balancer. | ||
|
|
||
| - Start server with default config: |
There was a problem hiding this comment.
Perhaps making it "traefik server" instead of just server? Same with below.
There was a problem hiding this comment.
I was merely matching the same wording used on the similar nginx page. I can adjust it if you'd like...
pages/common/traefik.md
Outdated
|
|
||
| `traefik` | ||
|
|
||
| - Start server with custom config file: |
There was a problem hiding this comment.
with custom config file -> with a custom config file might read better.
There was a problem hiding this comment.
As I stated in your other change, this was mirror to the Nginx page's wording. I'm open to changing it if you feel it's necessary.
There was a problem hiding this comment.
Here it reads as better English if it has an article before the noun "config file", so I think this change is still needed. I'll update the nginx page too, if everyone else is ok with this?
|
I've applied all requested grammar fixes to my pull request. Thanks for the feedback. |
Closes #1184
The page (if new), does not already exist in the repo.
The page (if new), has been added to the correct platform folder:
common/if it's common to all platforms,linux/if it's Linux-specific, and so on.The page has 8 or fewer examples.
The PR is appropriately titled:
<command name>: add pagefor new pages, or<command name>: <description of changes>for pages being editedThe page follows the contributing guidelines