docs: general documentation rework #850
Conversation
sh0rez
changed the title
|
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. |
|
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 Edit: I should say this is something to consider, there are pros/cons to this approach. |
|
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 🙂 |
|
Hi! The merge conflicts to not seem to be resolved, revisit that please. And yes, of course go ahead 😊 |
|
@sh0rez oops, thanks 😛 |
|
@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. |
|
Rebased, might have lost some changes of #654 though. Check the moved / refactored /cc @cyriltovena |
- restructures the docs to make them easier to explore - rewrites promtail docs - unifies, shortens and extends docs
|
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. |
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.