Commit Graph
25 Commits
Author SHA1 Message Date
Jack Baldry a54d18c1f5 Revert "Add Grafana tutorials originally from tutorials repository" (#62283)
Revert "Add Grafana tutorials originally from tutorials repository (#62124)"

This reverts commit f98ad926ac.
2023-01-27 09:25:57 +00:00
Jack Baldry f98ad926ac Add Grafana tutorials originally from tutorials repository (#62124)
* Add Grafana tutorials originally from tutorials repository

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

* Replace tutorials/step shortcode with ordinary headings

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

* Fix typos reported by codespell

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

* Fix doc-validator linting and run prettier

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-27 09:14:24 +00:00
Jack Baldry 6706f08ecd Replace grafana/docs-squad with more specific group grafana/docs-grafana (#62174) 2023-01-27 08:27:36 +00:00
Jack Baldry f4be855e30 Update doc-validator to latest release (#62170)
* Update doc-validator to latest release

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

* Skip image validation

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-26 14:29:26 +00:00
Jack Baldry 017d4f2cbb Pin doc-validator image version to allow repository to opt in to breaking changes (#61456)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-13 11:40:30 +00:00
Jack Baldry 87ccf10ffe Update publishing workflows to use PATs with fine-grained access control (#61098)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-11 10:53:26 +00:00
Jack Baldryandsam boyer 410b23c3d9 Use preferred package header for generated code (#61059)
* Use preferred package header for generated code

> To convey to humans and machine tools that code is generated, generated source should have a line that matches the following regular expression (in Go syntax):
> `^// Code generated .* DO NOT EDIT\.$`

https://pkg.go.dev/cmd/go#hdr-Generate_Go_files_by_processing_source

Co-authored-by: sam boyer <sdboyer@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Regenerate files with updated header

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: sam boyer <sdboyer@grafana.com>
2023-01-06 04:57:45 -05:00
Jack Baldry 1516aa2762 Remove packages path from branch filter (#60128)
That directory is no longer used in published docs and causes this
workflow to fail when changes only affect the packages directory.

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-04 10:18:44 +00:00
Jack Baldry 97f01c0d1a Apply linting advice from doc-validator tool (#59606)
* Apply linting advice from doc-validator tool

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

* Prettier

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-19 09:49:44 +00:00
Jack Baldry 6f9ee7acf9 Fix branch filter for release workflows (#59963)
Ensures the workflow is run on every push to all version branches.

This was thought to be working because it was tested with a manual
dispatch, however, that trigger does not consider filters and was not
an accurate test.

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 13:52:06 -04:00
Jack Baldry c1c48dd610 Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

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

* Remove aliases from shared pages

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

* Rewrite all current latest aliases to be next

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

* Fix typo in latest alias

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

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

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

* Prettier

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00
Jack Baldry e7bdcb4ba8 Restrict workflow to grafana/grafana repository (#59740)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-02 15:29:57 -05:00
Jack Baldry a343defe64 Fix release_branch_regexp (#59590)
Apparently the non-capturing group was incorrect.

I verified the logic in a branch in grafana-github-actions:
https://github.com/grafana/grafana-github-actions/compare/jdb/2022-11-prove-grafana-regexp-behaves-correctly?expand=1

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-11-30 12:37:03 -04:00
Jack Baldry 6d6cb0a478 Remove dependency on test job (#59575)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-11-30 11:13:46 -04:00
Jack Baldry 10a83714c8 Automate docs publishing steps (#59550)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-11-30 10:04:23 -04:00
Jack Baldry b9d8bcb59b Use relref resolved from nearest section (#58718)
As image-rendering is a branch bundle, it is considered a section by
Hugo and relrefs should be resolved from there even for child pages.

The behavior that worked in `next` but not `latest` could be explained
by the lenient but potentially ambiguous relref resolution algorithm
Hugo uses. However, I have not determined the exact difference between
the two sets of content that causes `next` to work but `latest` not to.

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-11-14 17:00:28 -04:00
Jack Baldry 1976edaffc Remove indentation from docs/list shortcode usage (#51715)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-07-07 14:02:35 -04:00
Jack Baldry 602ee37533 Add doc-validator tool to CI (#51698)
* Add doc-validator tool to CI

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

* Use simpler apostrophe to make title match h1

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

* Ensure doc-validator CI always passes until all errors are resolved

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-07-07 08:58:51 +01:00
Jack BaldryandBrenda Muir d0808bdafb Add redirects for indexed alerting pages (#50918)
Co-authored-by: Brenda Muir <brenda.muir@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Brenda Muir <brenda.muir@grafana.com>
2022-06-16 10:32:40 +02:00
Jack Baldry 4cc3bc37a0 Use more relevant links to legacy alerting documentation (#50607)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-06-13 16:14:32 +02:00
Jack Baldry e82784bff0 Use ref links for external content (#49786)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-31 09:35:52 -05:00
Jack Baldryandeleijonmarck 0a23299878 Fix typo in curl command (#46729)
* Fix typo in curl command

Co-authored-by: eleijonmarck <eric.leijonmarck@gmail.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo in another curl command

Co-authored-by: eleijonmarck <eric.leijonmarck@gmail.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: eleijonmarck <eric.leijonmarck@gmail.com>
2022-05-30 14:02:04 +02:00
Jack Baldry b84294dd27 Convert TOML front matter to YAML (#49690)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-26 11:06:25 -04:00
Jack Baldry dea6fb4c1b Add current aliases (#49346)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-20 13:35:28 -05:00
Jack Baldry 51dfcd7d37 Add current alias to all files (#48635)
* Add aliases to all files

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

* Prettify front matter

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-17 08:24:11 -07:00