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	34915c7bd7	Spell out Kubernetes in docs (#10922 ) Developers tend to abbreviate "Kubernetes" to just K8, but as a best practice it should be spelled out in the documentation.	2 years ago
J Stickler	aed39c89ee	[docs] Replace ampersand with the word "and" (#10637 ) Replacing the ampersand character (&) with the word `and` to conform to the Style Guide https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/#punctuation-guidelines Do not abbreviate and with an ampersand (&).	2 years ago
J Stickler	71d526a23a	[Style updates] Capitalize Loki when referring to project. (#10462 ) What this PR does / why we need it: Went through and looked for places where Loki should be capitalized because we are talking about the product or project (vs. in configuration examples, etc. where lower case is acceptable or required).	2 years ago
J Stickler	8e59fcac91	Update redirects to use new alias format. (part 2 of 2) (#9890 ) Breaking the alias updates into two PRs to make for smaller reviews. Special notes for your reviewer: @jdbaldry commented on #9717 that the alias format had changed, but we [agreed](https://github.com/grafana/loki/pull/9717#issuecomment-1594960563) that I could update it in a follow up PR. This is that follow up. Also updating previously merged file moves that used the old alias format. <strike>I could not get relative redirects to work for the LIDS or Maintaining files, so had to use the older format, which did work.</strike> Updated weights for some pages. Updated a couple of `menuTitles` that I missed updating on previous PRs. --------- Co-authored-by: Jack Baldry <jack.baldry@grafana.com>	2 years ago
J Stickler	11e2375e6d	Removing 'please' from the docs. (#9658 ) Which issue(s) this PR fixes: Fixes #8922 Special notes for your reviewer: This is to conform with our Style Guide. https://developers.google.com/style/tone#politeness-and-use-of-please	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
J Stickler	ce9e5353d3	TOC Sync: Move design docs, LIDs and maintaining under Community. (#9202 ) What this PR does / why we need it: Which issue(s) this PR fixes: Fixes #8720 Special notes for your reviewer: Part of the Database products table of contents alignment project. Moves Maintaining, Design Documents, and LID files under Community heading in TOC. Updates front matter for the topics. Adds aliases for redirects.	3 years ago

8 Commits (36e3d7ea61b77d88ea63a8e237fd013043f0411b)