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

docs: fix broken urls (launchpad/backports) #7833

Merged
merged 1 commit into from
Nov 17, 2020

Conversation

lovincyrus
Copy link
Contributor

Description

  • fix broken URLs in docs

Ref: cosmos/vuepress-theme-cosmos#140


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Copy link
Contributor

@ethanfrey ethanfrey left a comment

Choose a reason for hiding this comment

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

Approve in theory, please adjust the links

@@ -103,7 +103,7 @@ Request types, which define structured interactions from users, must be defined

Here is an example of a request to buy a name from the `nameservice` module:

+++ https://github.com/cosmos/sdk-tutorials/blob/master/nameservice/x/nameservice/client/rest/tx.go#L14-L19
+++ https://github.com/cosmos/cosmos-sdk/blob/7f59723d889b69ca19966167f0b3a7fec7a39e53/x/bank/client/rest/tx.go#L15-L19
Copy link
Contributor

Choose a reason for hiding this comment

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

I approve of changing theblinks, using either a tag or commit hash. But could you use the same commit hash/tag in all links?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Understood, I tried it with the same commit hash that is being used by other updated URLs but it's invalid.

Same commit hash: https://github.com/cosmos/sdk-tutorials/blob/86a27321cf89cc637581762e953d0c07f8c78ece/nameservice/x/nameservice/internal/keeper/querier.go#L19-L32

86a27321cf89cc637581762e953d0c07f8c78ece

Invalid URL with the same commit hash: https://github.com/cosmos/cosmos-sdk/blob/86a27321cf89cc637581762e953d0c07f8c78ece/x/bank/client/rest/tx.go#L15-L19

FYI: I've updated the broken links with the same links from master so they should be fine.

@@ -149,7 +149,9 @@ The [`handler`](../building-modules/handler.md) refers to the part of the module
The `handler` of a module is generally defined in a file called `handler.go` and consists of:

- A **switch function** `NewHandler` to route the message to the appropriate `handler` function. This function returns a `handler` function, and is registered in the [`AppModule`](#application-module-interface) to be used in the application's module manager to initialize the [application's router](../core/baseapp.md#routing). Next is an example of such a switch from the [nameservice tutorial](https://github.com/cosmos/sdk-tutorials/tree/master/nameservice)
+++ https://github.com/cosmos/sdk-tutorials/blob/master/nameservice/x/nameservice/handler.go#L12-L26

+++ https://github.com/cosmos/sdk-tutorials/blob/86a27321cf89cc637581762e953d0c07f8c78ece/nameservice/x/nameservice/internal/keeper/querier.go#L19-L32
Copy link
Contributor

Choose a reason for hiding this comment

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

Eg this is a different commit

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that's because I'm using the updated URL from masterhttps://github.com/cosmos/cosmos-sdk/blame/master/docs/basics/app-anatomy.md#L209

@amaury1093 amaury1093 added backport/0.39.x (Launchpad) T:Docs Changes and features related to documentation. labels Nov 6, 2020
@lovincyrus lovincyrus requested a review from ethanfrey November 6, 2020 17:45
@fedekunze fedekunze added the A:automerge Automatically merge PR once all prerequisites pass. label Nov 9, 2020
@lovincyrus
Copy link
Contributor Author

I'm not authorized to merge. Can someone with write access merge this PR? 🙏

@alessio alessio merged commit 2d38dad into launchpad/backports Nov 17, 2020
@alessio alessio deleted the cyrus/0.39-broken-links branch November 17, 2020 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants