Skip to content

docs(tests/starship): fix broken link#20123

Merged
julienrbrt merged 1 commit into
cosmos:mainfrom
seay404:main
Apr 22, 2024
Merged

docs(tests/starship): fix broken link#20123
julienrbrt merged 1 commit into
cosmos:mainfrom
seay404:main

Conversation

@seay404

@seay404 seay404 commented Apr 22, 2024

Copy link
Copy Markdown
Contributor

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Updated URLs in setup instructions within the documentation for connecting to a Kubernetes cluster.

@seay404 seay404 requested a review from a team April 22, 2024 08:58
@coderabbitai

coderabbitai Bot commented Apr 22, 2024

Copy link
Copy Markdown
Contributor
Walkthrough

Walkthrough

The update involves changing the URLs in the documentation links within the README.md file of the starship test directory. The new URLs redirect users to the updated setup instructions hosted at docs.cosmology.zone, specifically for connecting to a Kubernetes cluster.

Changes

File Path Change Summary
tests/.../README.md Updated URLs from starship.cosmology.tech to docs.cosmology.zone for Kubernetes setup instructions.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 63f386e and c836667.
Files selected for processing (1)
  • tests/starship/README.md (1 hunks)
Additional Context Used
LanguageTool (31)
tests/starship/README.md (31)

Near line 3: Possible spelling mistake found.
Context: ...is a tool to help simulate real chains, relayers and the interchain infra in a k8s clust...


Near line 3: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...eal chains, relayers and the interchain infra in a k8s cluster, locally, in the CI an...


Near line 6: Possible spelling mistake found.
Context: ...clusters. Perfect for running internal devnets, and writing e2e tests. Starship helps ...


Near line 10: This sentence does not start with an uppercase letter.
Context: .... ## Directory Structure * configs/ is a directory holding various kinds of co...


Near line 21: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...etting Started ### Setup dependencies Checkout the [docs](https://docs.cosmology.zone/...


Near line 27: Possible spelling mistake found.
Context: ...ash make setup-deps ``` ### Connect to kubernetes cluster Connect to a k8s cluster. Foll...


Near line 30: Unpaired symbol: ‘[’ seems to be missing
Context: ... based on your operating system * [2.1.1](https://docs.cosmology.zone/starship/ge...


Near line 30: Possible spelling mistake found.
Context: ...uster): Spin up using kind cluster, for linux * [2.1.2](https://docs.cosmology.zone/s...


Near line 31: Unpaired symbol: ‘[’ seems to be missing
Context: ...p using kind cluster, for linux * [2.1.2](https://docs.cosmology.zone/starship/ge...


Near line 56: Possible missing comma found.
Context: ...``` Once all the pods are in Running state run port-forward command to get all por...


Near line 70: Possible spelling mistake found.
Context: ...`bash make stop ``` If you spun up the kubernetes cluster, then please stop it or if you ...


Near line 74: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...e same tests against an already running infra. This will save the cost of initializat...


Near line 96: Consider a more formal alternative to strengthen your wording.
Context: ...eshooting local setup Currently, there seems to be some issues when running starship...


Near line 102: Possible spelling mistake found.
Context: .... Increase the resources for your local kubernetes cluster. * Docker Desktop: Go to `Set...


Near line 104: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ...Resources, increase CPU and memory 2. Reduce the resources for each of the nodes in ...


Near line 104: Did you mean “chains use” or “chain uses”?
Context: ...erstand the resource directive in the chains * configs/ci.yaml uses very little resources, so should be abl...


Near line 105: It’s possible that you’re missing a subject here.
Context: ...gs/ci.yaml` uses very little resources, so should be able to run locally > NOTE: When re...


Near line 107: Possible spelling mistake found.
Context: ...ld be able to run locally > NOTE: When resoureces are reduced or if the devnet has been r...


Near line 107: Possible spelling mistake found.
Context: ...: When resoureces are reduced or if the devnet has been running for a longer time, the...


Near line 107: Consider adding a comma here.
Context: ...to memory overflow. Will be fixed soon. For now > one can just run ```bash make delete ...


Near line 125: Possible spelling mistake found.
Context: ...We will get rid of the whole scripts/ dir and replace it with a handy starship ...


Near line 125: Possible spelling mistake found.
Context: ... and replace it with a handy starship cli tool. * Local infra spinup, specially o...


Near line 126: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...th a handy starship cli tool. * Local infra spinup, specially on a Mac takes alot o...


Near line 126: Possible spelling mistake found.
Context: ...andy starship cli tool. * Local infra spinup, specially on a Mac takes alot of time,...


Near line 126: Possible spelling mistake found.
Context: ... infra spinup, specially on a Mac takes alot of time, this is something we will spee...


Near line 126: The word “speedup” is a noun. The verb is spelled with a space.
Context: ...alot of time, this is something we will speedup much more * We will have auto resource ...


Near line 128: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...ing is reduced * Longer running pods or infra without issues. ### Testing/Infra * Ad...


Near line 130: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...s or infra without issues. ### Testing/Infra * Add more tests based on requirements,...


Near line 131: Possible spelling mistake found.
Context: ...ased on requirements, port all existing adhoc tests to Starship * Add build system in...


Near line 132: Possible spelling mistake found.
Context: ...rship * Add build system into starship (premetive exists) to be able to build the current...


Near line 132: Possible spelling mistake found.
Context: ...exists) to be able to build the current simapp from the branch * Start from non-empty ...

Path-based Instructions (1)
tests/starship/README.md (2)

Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (9)
tests/starship/README.md (9)

22-22: Update the URL to ensure users are directed to the correct documentation.


30-31: Ensure the updated URLs are correct and accessible.


Line range hint 3-3: Consider replacing "infra" with a more universally understood term like "infrastructure" to enhance clarity.


Line range hint 6-6: Possible spelling mistake: "devnets" might be intended as "dev nets" or "development networks".


21-21: The phrase "Checkout the docs" should start with a verb for clarity, consider "Check out the docs".


27-27: Correct the spelling of "kubernetes" to "Kubernetes" to adhere to proper noun conventions.


Line range hint 70-70: Correct the spelling of "kubernetes" to "Kubernetes".


Line range hint 102-102: Correct the spelling of "kubernetes" to "Kubernetes".


Line range hint 126-126: Change "speedup" to "speed up" to use the correct verb form.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Actionable comments outside the diff hunks (2)
tests/starship/README.md (2)

Line range hint 107-107: Correct the spelling of "resoureces" to "resources".

- When resoureces are reduced or if the devnet has been running for a longer time, then the pods seem to die out or keep restarting.
+ When resources are reduced or if the devnet has been running for a longer time, then the pods seem to die out or keep restarting.

Line range hint 126-126: Correct the spelling of "alot" to "a lot".

- Local infra spinup, specially on a Mac takes alot of time, this is something we will speedup much more
+ Local infra spinup, especially on a Mac takes a lot of time, this is something we will speed up much more

Comment thread tests/starship/README.md
Comment on lines +30 to +31
* [2.1.1](https://docs.cosmology.zone/starship/get-started/step-2#211-setup-with-kind-cluster): Spin up using kind cluster, for linux
* [2.1.2](https://docs.cosmology.zone/starship/get-started/step-2#212-setup-with-docker-desktop): Using docker-desktop, for mac

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The list items here seem to be missing the opening bracket '[' which might cause rendering issues in Markdown.

- * [2.1.1](https://docs.cosmology.zone/starship/get-started/step-2#211-setup-with-kind-cluster): Spin up using kind cluster, for linux
- * [2.1.2](https://docs.cosmology.zone/starship/get-started/step-2#212-setup-with-docker-desktop): Using docker-desktop, for mac
+ * [2.1.1](https://docs.cosmology.zone/starship/get-started/step-2#211-setup-with-kind-cluster): Spin up using kind cluster, for Linux
+ * [2.1.2](https://docs.cosmology.zone/starship/get-started/step-2#212-setup-with-docker-desktop): Using Docker Desktop, for Mac

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* [2.1.1](https://docs.cosmology.zone/starship/get-started/step-2#211-setup-with-kind-cluster): Spin up using kind cluster, for linux
* [2.1.2](https://docs.cosmology.zone/starship/get-started/step-2#212-setup-with-docker-desktop): Using docker-desktop, for mac
* [2.1.1](https://docs.cosmology.zone/starship/get-started/step-2#211-setup-with-kind-cluster): Spin up using kind cluster, for Linux
* [2.1.2](https://docs.cosmology.zone/starship/get-started/step-2#212-setup-with-docker-desktop): Using Docker Desktop, for Mac

@julienrbrt julienrbrt changed the title chore(tests/starship):fix broken link docs(tests/starship): fix broken link Apr 22, 2024

@julienrbrt julienrbrt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks!

@julienrbrt julienrbrt added this pull request to the merge queue Apr 22, 2024
Merged via the queue into cosmos:main with commit d11304b Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants