Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to markdown links #9384

Merged
merged 9 commits into from
Sep 8, 2022
Merged

Update to markdown links #9384

merged 9 commits into from
Sep 8, 2022

Conversation

samricotta
Copy link
Contributor

@samricotta samricotta commented Sep 7, 2022

This resolves issue #9181 in ensuring all of the markdown links work so that the linter passes during the CI tests.

There are still a few that will need to be updated, which I couldn't find replacements for.

  1. https://docs.google.com/document/d/11ZhMsCj3y7zIZz4udO9l25xqb0kl7gmWqNpGVRzOeyY/edit - here
  2. https://www.zurich.ibm.com/~cca/papers/sieve.pdf - here

If someone could help out with the above ^^ that would be great

@samricotta samricotta added the S:wip Work in progress (prevents stalebot from automatically closing) label Sep 7, 2022
@samricotta samricotta requested review from a team September 7, 2022 09:30
@sergio-mena
Copy link
Contributor

https://www.zurich.ibm.com/~cca/papers/sieve.pdf

This link seems to point to that paper.

Copy link
Contributor

@sergio-mena sergio-mena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this Sam!

@@ -0,0 +1,776 @@
<!-- markdown-link-check-disable -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file. It was deleted by Jasmina's #9288

@@ -144,6 +144,6 @@ Message is a [`oneof` protobuf type](https://developers.google.com/protocol-buff
| proposal_pol | [ProposalPOL](#proposalpol) | | 4 |
| block_part | [BlockPart](#blockpart) | | 5 |
| vote | [Vote](#vote) | | 6 |
| received_vote | [ReceivedVote](#ReceivedVote) | | 7 |
| received_vote | [ReceivedVote](#receivedvote) | | 7 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to fix the spacing here

@@ -29,7 +29,7 @@ PexResponse is an list of net addresses provided to a peer to dial.

| Name | Type | Description | Field Number |
|-------|------------------------------------|------------------------------------------|--------------|
| addresses | repeated [PexAddress](#PexAddress) | List of peer addresses available to dial | 1 |
| addresses | repeated [PexAddress](#pexaddress) | List of peer addresses available to dial | 1 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix spacing of tables in the changes to this file

@sergio-mena
Copy link
Contributor

https://docs.google.com/document/d/11ZhMsCj3y7zIZz4udO9l25xqb0kl7gmWqNpGVRzOeyY

This is a "fork accountability report". I didn't find a substitute link for this. Maybe @josef-widder, when he's back for leave could find a place we could point to.

@samricotta
Copy link
Contributor Author

@sergio-mena in that case should I disable this link for now and when we find a replacement link?

@sergio-mena
Copy link
Contributor

should I disable this link for now and when we find a replacement link?

I agree with that

@samricotta
Copy link
Contributor Author

@sergio-mena one last link! I have disabled it for now https://github.com/tendermint/tendermint/blob/main/CHANGELOG.md?plain=1#L1227 but this is another one that I cannot find the docs for

DOCKER/README.md Outdated
Comment on lines 11 to 12
<!-- markdown-link-check-disable-next-line -->
Respective versioned files can be found <https://raw.githubusercontent.com/tendermint/tendermint/vX.XX.XX/DOCKER/Dockerfile> (replace the Xs with the version number).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't really be a link.

Suggested change
<!-- markdown-link-check-disable-next-line -->
Respective versioned files can be found <https://raw.githubusercontent.com/tendermint/tendermint/vX.XX.XX/DOCKER/Dockerfile> (replace the Xs with the version number).
Respective versioned files can be found at `https://raw.githubusercontent.com/tendermint/tendermint/vX.XX.XX/DOCKER/Dockerfile` (replace the Xs with the version number).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed

RELEASES.md Outdated
@@ -45,7 +45,7 @@ the 0.38.x line.
1. Start on `main`

2. Ensure that there is a [branch protection
rule](https://github.com/tendermint/tendermint/settings/branches) for the
rule](https://github.com/tendermint/tendermint/branches) for the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically the original link was correct, but it may be showing up as a 404 because you need admin privileges to access it. Let's rather substitute with GitHub's documentation here.

Suggested change
rule](https://github.com/tendermint/tendermint/branches) for the
rule](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) for the

@@ -1,3 +1,3 @@
# Consensus

See the [consensus spec](https://github.com/tendermint/tendermint/tree/main/spec/consensus) and the [reactor consensus spec](https://github.com/tendermint/tendermint/tree/main/spec/reactors/consensus) for more information.
See the [consensus spec](https://github.com/tendermint/tendermint/tree/main/spec/consensus)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See the [consensus spec](https://github.com/tendermint/tendermint/tree/main/spec/consensus)
See the [consensus spec](https://github.com/tendermint/tendermint/tree/main/spec/consensus) for more information.

@sergio-mena
Copy link
Contributor

@sergio-mena one last link!

Will this do? 😀
https://docs.tendermint.com/v0.34/tutorials/java.html

@samricotta samricotta merged commit 5013bc3 into main Sep 8, 2022
@samricotta samricotta deleted the markdown-links branch September 8, 2022 08:31
@@ -45,7 +45,7 @@ the 0.38.x line.
1. Start on `main`

2. Ensure that there is a [branch protection
rule](https://github.com/tendermint/tendermint/settings/branches) for the
rule](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) for the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samricotta this is the line and link with the unreachable link....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S:wip Work in progress (prevents stalebot from automatically closing)
Projects
Status: Done/Merged
Development

Successfully merging this pull request may close these issues.

None yet

5 participants