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

Documentation Rewrite #982

Merged
merged 72 commits into from
Sep 25, 2019
Merged

Documentation Rewrite #982

merged 72 commits into from
Sep 25, 2019

Conversation

rfratto
Copy link
Member

@rfratto rfratto commented Sep 6, 2019

This PR rewrites and restructures all of the documentation with the following goals:

  1. Organize through a table of contents to build a suggested "learning path"
  2. Add or otherwise improve documentation to explain Loki more concisely

Closes #94

docs/README.md Outdated Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
@rfratto rfratto force-pushed the docs-rewrite branch 3 times, most recently from 9f6972a to 65c0518 Compare September 17, 2019 16:54
@rfratto rfratto marked this pull request as ready for review September 18, 2019 16:12
@rfratto
Copy link
Member Author

rfratto commented Sep 18, 2019

This is ready for review. I'm looking for any and all feedback about content, formatting, etc.!

docs/README.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
@rfratto
Copy link
Member Author

rfratto commented Sep 25, 2019

So at this point I think this is ready for a final look-over and a merge. I'm sure there's always going to be some areas to improve the documentation, but I don't want this sitting around forever and I think this is good progress for the docs. Please open new issues for new improvements once this is finally merged 🙂

/cc @cyriltovena

Copy link
Contributor

@cyriltovena cyriltovena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cyriltovena cyriltovena merged commit 65ba42a into grafana:master Sep 25, 2019
@rfratto rfratto deleted the docs-rewrite branch September 25, 2019 17:58
@pstibrany
Copy link
Member

Congrats on merging, this was a huge effort on your part and updated docs look great!

@pracucci
Copy link
Contributor

Thanks @rfratto for patiently addressing my feedback. You did a great job! 👏 👏 👏

@schrej schrej mentioned this pull request Dec 10, 2019
cyriltovena pushed a commit to cyriltovena/loki that referenced this pull request Jun 11, 2021
* Make Cache a generic interface which FiFo also implements

Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>

* Make index cache use the generic interface

Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>

* Add memcache as a cache option to the Index

Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>

* Handle unicode with hack. Memcache cannot deal with it.

Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>

* Do client side expiry validation as write back might skew times

Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>

* Add metrics

Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>

* protobuf and review feedback

Signed-off-by: Goutham Veeramachaneni <gouthamve@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Something existing could be improved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fluentd / Fluentbit comparison to Loki / Promtail
8 participants