apitech/loki - loki - Gitea: Git with a cup of tea

Commit Graph

Author	SHA1	Message	Date
J Stickler	0dc8c75331	Update admonitions to add shortcode (#11622 ) What this PR does / why we need it: Completing the work that was started in #9409 but not completed because there were multiple variations on how to format notes in the docs source files. We rolled out different colors for admonitions recently, which highlighted that there were still a few notes not using the admonition shortcode. I searched the docs for the following words: * tip * caution * important * warning * note So hopefully I've caught all of the admonitions that weren't using the shortcode.	2 years ago
J Stickler	efdea22db4	Update descriptions (#11586 ) What this PR does / why we need it: Updates the `description` field in the metadata to support the Docs Landing Page project --------- Co-authored-by: Michel Hollands <42814411+MichelHollands@users.noreply.github.com>	2 years ago
J Stickler	1f408305c4	[Docs] Create top level Manage section (#10461 ) What this PR does / why we need it: Part of the Epic to create a consistent documentation information architecture across the three DB projects. Which issue(s) this PR fixes: Fixes #8718 Special notes for your reviewer: The original Issue called for moving files under Manage, but rather than rename the folder and break links, I chose to make the "move" by updating the topic metadata. This PR also includes updates to topic metadata and removes or updates page weights.	2 years ago
Ward Bekker	7733be0658	making clearer that TSDB is the new recommended index, and make expli… (#9246 ) What this PR does / why we need it: making clearer that TSDB is the new recommended index, and make explicit that non TSDB and BoltDB shipper are deprecated and not recommended Fixes #9105 Special notes for your reviewer: This needs to be changed in more places, but this is a start as it concerns the main storage docs Checklist - [X] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (required) - [X] Documentation added - [ ] Tests updated - [ ] `CHANGELOG.md` updated - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md` --------- Co-authored-by: Travis Patterson <masslessparticle@gmail.com> Co-authored-by: J Stickler <julie.stickler@grafana.com> Co-authored-by: Travis Patterson <travis.patterson@grafana.com>	2 years ago
J Stickler	7797a98074	TOC Sync: Move configuration files under Configure (#9879 ) Which issue(s) this PR fixes: Fixes #8713 Special notes for your reviewer: Replaces PR [#8817](https://github.com/grafana/loki/pull/8817), which was stale and badly out of date. Part of the Database products table of contents alignment project. Moves configuration files from Configuration to new Configure heading in TOC. Updates front matter for the topic. Fixes links broken by the move. Updates the MakeFile to point to the new Configure DOCS_SOURCES_PATH.	2 years ago
J Stickler	32320736db	TOC Sync: Move files under Get Started. (#9717 ) Which issue(s) this PR fixes: Fixes #8711 Special notes for your reviewer: Part of the Database products table of contents alignment project. Moves Getting Started and Fundamentals files under Get Started in TOC. Updates front matter for the topic (headings, page weights, descriptions, aliases to redirect from old URL to new URL) Fixes links broken by the move.	3 years ago
Jack Baldry	8391e557b1	Update doc-validator to v3.0.0 (#9666 ) ## 3.0.0 ### Added - Structured output for use with [`reviewdog`](https://github.com/reviewdog/reviewdog). You can achieve the original error output by piping the output to the following `jq` expression: `jq -r '"ERROR: \(.location.path):\(.location.range.start.line):\(.location.range.start.column): \(.message)"'`. - Suggestions for simple link fixes. In GitHub, [`reviewdog`](https://github.com/reviewdog/reviewdog) comments these suggestions for convenient replacement. - Support for anchors referring to repeated headings. In the case that a page has multiple headings that share the same text, the renderer appends a zero indexed, numbered suffix to the identifier. For example, when there are two headings that are both "Heading text", the first anchor identifier is `heading-text` and the second is `heading-text-1`. - Error when running `doc-validator` on no files. Notes for reviewer: This also updates the `make-docs` procedure. Please ensure you can run `make docs` from the `docs/` directory before approving and merging this PR. --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago
René Scheibe	e050d5c494	Docs: Update Loki GitHub URLs (#9080 ) * use `main` instead of `master` branch * fix outdated URLs	3 years ago
Travis Patterson	1c954166b8	Fix documentation linter errors (#8229 )	3 years ago

9 Commits (36e3d7ea61b77d88ea63a8e237fd013043f0411b)