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: general documentation rework #850

Merged
merged 7 commits into from
Sep 6, 2019
Merged

docs: general documentation rework #850

merged 7 commits into from
Sep 6, 2019

Conversation

sh0rez
Copy link
Member

@sh0rez sh0rez commented Aug 5, 2019

This PR does a general rework of the documentation.
The current documentation does not have a clear entrypoint and and no red line to follow. This restructures and extends the docs to improve the situation.

  • Overview
  • Promtail
  • LogCLI
  • Loki

@sh0rez sh0rez self-assigned this Aug 5, 2019
@sh0rez sh0rez marked this pull request as ready for review August 6, 2019 08:55
docs/querying.md Outdated Show resolved Hide resolved
docs/querying.md Outdated Show resolved Hide resolved
@sh0rez sh0rez changed the title WIP docs: general documentation rework docs: general documentation rework Aug 6, 2019
@slim-bean
Copy link
Collaborator

It's hard to comment on specific file renames but I would rather not make the canary changes proposed, to me it makes more sense to keep the canary directory with the files within it as is, this both seems more consistent with the folders you setup for loki/promtail and it also avoids breaking existing links to these pages which I know exist from our grafana.com blog posts.

Similarly I would not move/rename the logentry/processing-log-lines.md for two reasons, one it's not promtail specific, the docker driver also can use the pipeline processing (and in the future Loki will also support this sever side) and second there are existing links to this document from our blogs.

@slim-bean
Copy link
Collaborator

slim-bean commented Aug 7, 2019

Also similar to the current canary structure I think every folder should have a README.md file, as this makes navigation through the github UI code browser much more pleasant, when you click on say the loki directory you should be presented with the contents of overview.md inside of README.md such that it will auto display in rendered format.

Edit: I should say this is something to consider, there are pros/cons to this approach.

@rfratto
Copy link
Member

rfratto commented Sep 3, 2019

Hi @sh0rez, I rebased against master and fixed the merge conflicts. I'm trying to get documentation improved this week so if you don't mind I'll be addressing @slim-bean's comments in another commit and merging this 🙂

@sh0rez
Copy link
Member Author

sh0rez commented Sep 3, 2019

Hi! The merge conflicts to not seem to be resolved, revisit that please.

And yes, of course go ahead 😊

@rfratto
Copy link
Member

rfratto commented Sep 3, 2019

@sh0rez oops, thanks 😛

@rfratto
Copy link
Member

rfratto commented Sep 3, 2019

@slim-bean PTAL to see if you're happy with the rework. I'll follow up with another PR to add more information after this is merged.

@sh0rez
Copy link
Member Author

sh0rez commented Sep 5, 2019

Rebased, might have lost some changes of #654 though.

Check the moved / refactored api.md (now loki/api.md).

/cc @cyriltovena

@rfratto
Copy link
Member

rfratto commented Sep 6, 2019

I rebased and re-added the docs from #654.

@cyriltovena @slim-bean I'm going to approve this and merge it; I want the changes in master so I can use them for my work.

Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

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

LGTM (even though I wrote a few commits 🙂)

@rfratto rfratto merged commit b74db24 into grafana:master Sep 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants