Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Multiples docker-driver configuration #2198

Closed
cyriltovena opened this issue Jun 8, 2020 · 4 comments
Closed

[Docs] Multiples docker-driver configuration #2198

cyriltovena opened this issue Jun 8, 2020 · 4 comments
Labels
good first issue These are great first issues. If you are looking for a place to start, start here! help wanted We would love help on these issues. Please come help us! keepalive An issue or PR that will be kept alive and never marked as stale.

Comments

@cyriltovena
Copy link
Contributor

cyriltovena commented Jun 8, 2020 •
edited
Loading

Describe the bug
We currently have 2 places for docker-driver documentation here and there.

This is confusing.

Expected behavior
We should merge everything in docs/clients/docker-driver and in the https://github.com/grafana/loki/tree/master/cmd/docker-driver/README.md we should just reference that the docs are at https://github.com/grafana/loki/tree/master/docs/clients/docker-driver

/cc @oddlittlebird @theMercedes WDYT ?
@cyriltovena cyriltovena added component/docs help wanted We would love help on these issues. Please come help us! good first issue These are great first issues. If you are looking for a place to start, start here! keepalive An issue or PR that will be kept alive and never marked as stale. labels Jun 8, 2020
@oddlittlebird
Copy link
Contributor

Is there a difference between the Docker Driver Client and the Docker Logging Driver?

@cyriltovena
Copy link
Contributor Author

None !

@cyriltovena
Copy link
Contributor Author

cyriltovena commented Jun 8, 2020 •
edited
Loading

Plus some docs is duplicated or only exist in one.

@oddlittlebird
Copy link
Contributor

In that case, I agree that the content should be merged. However, one topic would be crazy long. It should be something like:

Docker Driver Client - concept info, explain what this is and why you use it

  • Install Docker Driver Client
  • Uninstall Docker Driver Client
  • Upgrade Docker Driver Client
  • Configure Docker Driver Client (this might be more than one)
  • Docker Driver Client options (to hold that long table in the middle of things)
  • Troubleshoot Docker Driver Client

@theMercedes, thoughts?

cyriltovena added a commit to cyriltovena/loki that referenced this issue Jul 22, 2020
@cyriltovena
Merge all documentation for docker-driver in one place.
00a1cef 
Fixes grafana#2198

Signed-off-by: Cyril Tovena <cyril.tovena@gmail.com>
@owen-d owen-d closed this as completed in 23f64ef Jul 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue These are great first issues. If you are looking for a place to start, start here! help wanted We would love help on these issues. Please come help us! keepalive An issue or PR that will be kept alive and never marked as stale.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cyriltovena @oddlittlebird