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.

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

Docs: Added labels content #1999

Merged
merged 4 commits into from
Apr 30, 2020
Merged

Docs: Added labels content #1999

merged 4 commits into from
Apr 30, 2020

Conversation

oddlittlebird
Copy link
Contributor

What this PR does / why we need it:

Took content from Ed's blog post and added it to the documentation. One topic is in Getting started, not sure that is the best place but did not see a better one. The other topic is in a new folder called Best Practices, which I hope you guys will add to over time.

It is needed because there is currently almost next to no content on labeling.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer: You might want to change some of the tone or remove some text to make it fit with the rest of your documentation.

Checklist

  • [x ] Documentation added

@slim-bean
Copy link
Collaborator

This is great thanks @oddlittlebird!

I think we should also add links to these new pages via the table of contents:

For getting started:

https://github.com/grafana/loki/blob/master/docs/README.md and https://github.com/grafana/loki/blob/master/docs/getting-started/README.md

For best practices:

I think we should add a new entry in: https://github.com/grafana/loki/blob/master/docs/README.md and I think a new README.md in the new best-practices folder.

Signed-off-by: Ed Welch <edward.welch@grafana.com>
@codecov-io
Copy link

Codecov Report

Merging #1999 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1999      +/-   ##
==========================================
+ Coverage   64.46%   64.48%   +0.01%     
==========================================
  Files         131      131              
  Lines       10038    10038              
==========================================
+ Hits         6471     6473       +2     
+ Misses       3084     3083       -1     
+ Partials      483      482       -1     
Impacted Files Coverage Δ
pkg/promtail/targets/tailer.go 78.40% <0.00%> (+2.27%) ⬆️

@owen-d
Copy link
Member

owen-d commented Apr 30, 2020

Excited to get this in. @oddlittlebird Would you be willing to make @slim-bean's suggestions?

@oddlittlebird
Copy link
Contributor Author

@owen-d , the links have already been applied.

@owen-d
Copy link
Member

owen-d commented Apr 30, 2020

I missed Ed including his changes, we should have merged this a few days back.

@owen-d owen-d merged commit 8b5c889 into master Apr 30, 2020
@owen-d owen-d deleted the docs-add-labels-content branch April 30, 2020 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants