Skip to content

Commit

Permalink
docs: fix URLs preventing generation and unblock CI (#5285)
Browse files Browse the repository at this point in the history 
* docs: fix Ian Billett's GitHub handle

I noticed that CI was failing [0] for PR
#5284 because Ian had changed
his GitHub handle from @ianbillett to @bill3tt. This commit fixes this.

[0] https://github.com/thanos-io/thanos/runs/6050355497?check_suite_focus=true#step:5:135

Signed-off-by: Lucas Servén Marín <[email protected]>

* docs: fix broken links to GitHub docs

Currently, documentation generation is failing because mdox can't fetch
some GitHub documentation pages since the URLs for the help content has
changed. This commit updates the links to use the correct URLs.

Signed-off-by: Lucas Servén Marín <[email protected]>

* MAINTAINERS.md: regenerate

Signed-off-by: Lucas Servén Marín <[email protected]>
  • Loading branch information
@squat
squat authored Apr 19, 2022
1 parent 81218af commit c8e308f
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 14 deletions.
3 changes: 3 additions & 0 deletions .mdox.validate.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@ validators:
# couldn't reach even when curl-ed.
- regex: 'cloud\.baidu\.com'
type: 'ignore'
# 403 when curl-ed from GitHub actions, though not from a developer machine. Likely due to secondary rate limits.
- regex: 'docs\.github\.com'
type: 'ignore'
20 changes: 10 additions & 10 deletions MAINTAINERS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ You can reach us under `[email protected]` email.

## Triage

We also have some nice souls that help triaging issues and PRs. See [here](https://help.github.com/en/articles/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization) for details about the role's permission.
We also have some nice souls that help triaging issues and PRs. See [here](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#repository-roles-for-organizations) for details about the role's permission.

Full list of triage persons is displayed below:

| Name | Slack | GitHub | Company |
|---------------|---------------|----------------------------------------------|---------|
| Adrien Fillon | `@Adrien F` | [@adrien-f](https://github.com/adrien-f) | |
| Ian Billett | `@billett` | [@ianbillett](https://github.com/ianbillett) | Red Hat |
| Martin Chodur | `@FUSAKLA` | [@fusakla](https://github.com/fusakla) | |
| Michael Dai | `@jojohappy` | [@jojohappy](https://github.com/jojohappy) | |
| Xiang Dai | `@daixiang0` | [@daixiang0](https://github.com/daixiang0) | |
| Jimmie Han | `@hanjm` | [@hanjm](https://github.com/hanjm) | Tencent |
| Matej Gera | `@Matej Gera` | [@matej-g](https://github.com/matej-g) | Red Hat |
| Name | Slack | GitHub | Company |
|---------------|---------------|--------------------------------------------|---------|
| Adrien Fillon | `@Adrien F` | [@adrien-f](https://github.com/adrien-f) | |
| Ian Billett | `@billett` | [@bill3tt](https://github.com/bill3tt) | Red Hat |
| Martin Chodur | `@FUSAKLA` | [@fusakla](https://github.com/fusakla) | |
| Michael Dai | `@jojohappy` | [@jojohappy](https://github.com/jojohappy) | |
| Xiang Dai | `@daixiang0` | [@daixiang0](https://github.com/daixiang0) | |
| Jimmie Han | `@hanjm` | [@hanjm](https://github.com/hanjm) | Tencent |
| Matej Gera | `@Matej Gera` | [@matej-g](https://github.com/matej-g) | Red Hat |

Please reach any of the maintainer on slack or email if you want to help as well.

Expand Down
6 changes: 3 additions & 3 deletions docs/release-process.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,11 @@ Feel free to mimic following PR: https://github.com/thanos-io/thanos/pull/3861
git push origin "v${tag}"
```

Signing a tag with a GPG key is appreciated, but in case you can't add a GPG key to your Github account using the following [procedure](https://help.github.com/articles/generating-a-gpg-key/), you can replace the `-s` flag by `-a` flag of the `git tag` command to only annotate the tag without signing.
Signing a tag with a GPG key is appreciated, but in case you can't add a GPG key to your GitHub account using the following [procedure](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key), you can replace the `-s` flag by `-a` flag of the `git tag` command to only annotate the tag without signing.

Please make sure that you are tagging the merge commit because otherwise GitHub's UI will show that there were more commits after your release.

2. Once a tag is created and pushed, **immediately** create a Github Release using the UI for this tag, as otherwise CircleCI will not be able to upload tarballs for this tag. Go to the releases page of the project, click on the `Draft a new release` button and select the tag you just pushed. Describe release and post relevant entry from changelog. Click `Save draft` **rather** than `Publish release` at this time. (This will prevent the release being visible before it has got the binaries attached to it.) *In case you did not manage to create the draft release before CircleCI run is finished (it will fail on the artifacts upload step in this case), you can re-trigger the run manually from the CircleCI dashboard *after* you created the draft release.*
2. Once a tag is created and pushed, **immediately** create a GitHub Release using the UI for this tag, as otherwise CircleCI will not be able to upload tarballs for this tag. Go to the releases page of the project, click on the `Draft a new release` button and select the tag you just pushed. Describe release and post relevant entry from changelog. Click `Save draft` **rather** than `Publish release` at this time. (This will prevent the release being visible before it has got the binaries attached to it.) *In case you did not manage to create the draft release before CircleCI run is finished (it will fail on the artifacts upload step in this case), you can re-trigger the run manually from the CircleCI dashboard *after* you created the draft release.*

3. You are also encouraged to include a list of (first time) contributors to the release. You can do this by clicking on `Auto-generate release notes`, which will generate this section for you (edit the notes as required to remove unnecessary parts).

Expand Down Expand Up @@ -149,5 +149,5 @@ Feel free to mimic following PR: https://github.com/thanos-io/thanos/pull/3861
The following changes to the above procedures apply:

* In line with [Semantic Versioning](http://semver.org/), append something like `-rc.0` to the version (with the corresponding changes to the tag name, the release name etc.).
* Tick the `This is a pre-release` box when drafting the release in the Github UI.
* Tick the `This is a pre-release` box when drafting the release in the GitHub UI.
* Still update `CHANGELOG.md`, but when you cut the final release later, merge all the changes from the pre-releases into the one final update.
2 changes: 1 addition & 1 deletion tutorials/katacoda/thanos/3-receiver/intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Let us know on https://github.com/thanos-io/thanos or #thanos slack channel link

### Contributed by:

* Ian Billett [@ianbillett](http://github.com/ianbillett)
* Ian Billett [@bill3tt](http://github.com/bill3tt)

0 comments on commit c8e308f

Please sign in to comment.