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

Commit Graph

Author	SHA1	Message	Date
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>	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	8ee9a2c3c7	TOC Sync: Move API docs under Reference. (#9203 ) Which issue(s) this PR fixes: Fixes #8719 Special notes for your reviewer: Part of the Database products table of contents alignment project. Moves API doc under Reference heading in TOC. Updates front matter for the topic. Fixes links broken by the move. Adds aliases for redirects.	3 years ago

Author

SHA1

Message

Date

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>

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

8ee9a2c3c7

TOC Sync: Move API docs under Reference. (#9203 )

**Which issue(s) this PR fixes**:
Fixes #8719

**Special notes for your reviewer**:
Part of the Database products table of contents alignment project.
Moves API doc under Reference heading in TOC.
Updates front matter for the topic.
Fixes links broken by the move.
Adds aliases for redirects.

3 years ago

3 Commits (89985399817dde28fe5b94de990133d904bc3e5b)