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

Commit Graph

Author	SHA1	Message	Date
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
Jack Baldry	2b92aeeab8	Update centralized make-docs procedure (#9287 ) What this PR does / why we need it: Supports Ubuntu Snap based Docker installations by using TMPDIR instead of an explicit tempfile. Because Ubuntu Snap packages have access to only the user's home directory, users must specify something like `TMPDIR="$(mktemp -d -q ~/.make-docs.XXXXX)"` in order to be able to run `make docs`. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago
Trevor Whitney	1283c42a80	Bring back centralized docs toolkit (undo revert in #9146 ) (#9147 ) What this PR does / why we need it: This reverts the revert in https://github.com/grafana/loki/pull/9146 with a slightly less "nuclear" solution. I think the problem was that CI was pulling `docs.mk` from `main`, and it was creating a diff between the version we had checked in. I changed `docs.mk` to point to a specific sha, which should prevent this in the future. I also opened a [PR](https://github.com/grafana/writers-toolkit/pull/228) against the writers-toolkit.	3 years ago

Author

SHA1

Message

Date

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

Jack Baldry

2b92aeeab8

Update centralized make-docs procedure (#9287 )

**What this PR does / why we need it**:
Supports Ubuntu Snap based Docker installations by using TMPDIR instead
of an explicit tempfile.

Because Ubuntu Snap packages have access to only the user's home
directory, users must specify something like `TMPDIR="$(mktemp -d -q
~/.make-docs.XXXXX)"` in order to be able to run `make docs`.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

3 years ago

Trevor Whitney

1283c42a80

Bring back centralized docs toolkit (undo revert in #9146 ) (#9147 )

**What this PR does / why we need it**:

This reverts the revert in https://github.com/grafana/loki/pull/9146
with a slightly less "nuclear" solution.

I think the problem was that CI was pulling `docs.mk` from `main`, and
it was creating a diff between the version we had checked in. I changed
`docs.mk` to point to a specific sha, which should prevent this in the
future.

I also opened a
[PR](https://github.com/grafana/writers-toolkit/pull/228) against the
writers-toolkit.

3 years ago

3 Commits (8d6bcd4083606b0271f2cbba67d5d73c2225292d)