Fix Getting Started documentation link in README#4550
Fix Getting Started documentation link in README#4550omniCoder77 wants to merge 3 commits intoapache:trunkfrom
Conversation
|
@jyothsnakonisa Requesting your review on this PR. |
|
@omniCoder77 do you have a JIRA for this? |
|
@jyothsnakonisa No, should I create one? |
|
I think you should, @smiklosovic can you please confirm if a JIRA has to be created for this change? |
|
@jyothsnakonisa @smiklosovic Is there anything remaining on my end for this to move forward to merge |
|
@omniCoder77 looks good to me, you can ask someone else for another review. |
README.asc
Outdated
|
|
||
| This short guide will walk you through getting a basic one node cluster up | ||
| and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's https://cassandra.apache.org/doc/latest/cassandra/getting_started/index.html[Getting Started Guide]. | ||
| and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's https://cassandra.apache.org/doc/4.1/cassandra/getting_started/index.html[Getting Started Guide]. |
There was a problem hiding this comment.
This PR is against trunk branch and I believe trunk has 5.x code as well. Is it OK to have this 4.1 specific link in README of trunk?
There was a problem hiding this comment.
Apologies for the oversight. In my initial attempts, I looked for a way to keep the latest reference without hitting a 404, but upon further investigation, I found that the versioned link for 5.0 (found here) is the correct destination for the trunk branch. I will update the PR to reflect this..
|
@jyothsnakonisa @skoppu22 I've identified two potential links for the trunk branch: one pointing to trunk and one to 5.0. Since trunk currently tracks the 5.x development line, which one would you prefer I use for the README? |
I believe link to 5.0 is more suitable for trunk. |
There was a problem hiding this comment.
Pull request overview
This PR fixes a broken documentation link in the README file. The Getting Started guide URL was returning a 404 error and has been updated to point to the correct documentation version.
Changes:
- Updated the Getting Started documentation link from
/doc/latest/to/doc/5.0/ - Changed URL path segment from
getting_startedtogetting-started(using hyphens instead of underscores)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.asc
Outdated
|
|
||
| This short guide will walk you through getting a basic one node cluster up | ||
| and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's https://cassandra.apache.org/doc/latest/cassandra/getting_started/index.html[Getting Started Guide]. | ||
| and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's https://cassandra.apache.org/doc/5.0/cassandra/getting-started/index.html[Getting Started Guide]. |
There was a problem hiding this comment.
The PR description states the link is updated to /doc/4.1/ but the actual change updates it to /doc/5.0/. This inconsistency between the PR description and the actual change should be resolved. Please verify that version 5.0 is the correct target version and update the PR description accordingly.
|
@bschoening Requesting your review on this PR. |
README.asc
Outdated
|
|
||
| This short guide will walk you through getting a basic one node cluster up | ||
| and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's https://cassandra.apache.org/doc/latest/cassandra/getting_started/index.html[Getting Started Guide]. | ||
| and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's https://cassandra.apache.org/doc/5.0/cassandra/getting-started/index.html[Getting Started Guide]. |
There was a problem hiding this comment.
The problem seems to be the underscore not the version. Have you tried simply changing getting_started -> getting-started and let it remain doc/latest.
|
@bschoening @jyothsnakonisa I'm not familiar with Cassandra's JIRA process for getting PRs merged. This is my first JIRA ticket I created. Since this PR has been approved, do I need to do anything else to get it merged? |
|
@omniCoder77 it needs a committer to apply the PR. |
|
@smiklosovic changes I purposed in PR were to change |
Updates the Getting Started guide URL from
/doc/latest/to/doc/5.0/to point to the correct documentation version.The
/doc/latest/URL returns a 404 error, while/doc/5.0/works correctly.