You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hbase.apache.org by "kuilong wan (Jira)" <ji...@apache.org> on 2025/03/07 16:58:00 UTC
[jira] [Updated] (HBASE-29173) Update outdated content in the README.md
[ https://issues.apache.org/jira/browse/HBASE-29173?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
kuilong wan updated HBASE-29173:
--------------------------------
Description:
1. I noticed that there are several broken links in the README.md file:
|| ||Current link||Correct link (maybe)||
|mail list|https://hbase.apache.org/mail-lists.html|https://hbase.apache.org/mailing-lists.html|
|source code|https://hbase.apache.org/source-repository.html|https://hbase.apache.org/scm.html|
|issue tracking|https://hbase.apache.org/issue-tracking.html|https://hbase.apache.org/issue-management.html|
|Apache License|https://hbase.apache.org/license.html|http://www.apache.org/licenses/LICENSE-2.0|
2. The 'Getting Start' section in README.md contains outdated or inaccurate information:
{code:java}
To get started using HBase, the full documentation for this release can be found under the doc/ directory that accompanies this README. Using a browser, open the docs/index.html to view the project home page (or browse https://hbase.apache.org). The hbase 'book' has a 'quick start' section and is where you should being your exploration of the hbase project. {code}
Maybe it should be like this:
{code:java}
To get started using HBase, view the project home page (https://hbase.apache.org). The hbase 'book' has a 'quick start' section and is where you should begin your exploration of the hbase project. {code}
If the approach is acceptable, I'm willing to create a pull request. Please let me know if I should proceed.
was:
1. I noticed that there are several broken links in the README.md file:
|| ||Current link||Correct link (maybe)||
|mail list|https://hbase.apache.org/mail-lists.html|https://hbase.apache.org/mailing-lists.html|
|source code|https://hbase.apache.org/source-repository.html|https://hbase.apache.org/scm.html|
|issue tracking|https://hbase.apache.org/issue-tracking.html|https://hbase.apache.org/issue-management.html|
|Apache License|https://hbase.apache.org/license.html|http://www.apache.org/licenses/LICENSE-2.0|
2. The 'Getting Start' section in README.md contains outdated or inaccurate information:
{code:java}
To get started using HBase, the full documentation for this release can be found under the doc/ directory that accompanies this README. Using a browser, open the docs/index.html to view the project home page (or browse https://hbase.apache.org). The hbase 'book' has a 'quick start' section and is where you should being your exploration of the hbase project. {code}
Maybe it should be like this:
{code:java}
To get started using HBase, view the project home page (https://hbase.apache.org). The hbase 'book' has a 'quick start' section and is where you should begin your exploration of the hbase project. {code}
If the approach is acceptable, I'm willing to create a pull request. Please let me know if I should proceed.
> Update outdated content in the README.md
> ----------------------------------------
>
> Key: HBASE-29173
> URL: https://issues.apache.org/jira/browse/HBASE-29173
> Project: HBase
> Issue Type: Bug
> Components: community
> Reporter: kuilong wan
> Priority: Trivial
>
> 1. I noticed that there are several broken links in the README.md file:
> || ||Current link||Correct link (maybe)||
> |mail list|https://hbase.apache.org/mail-lists.html|https://hbase.apache.org/mailing-lists.html|
> |source code|https://hbase.apache.org/source-repository.html|https://hbase.apache.org/scm.html|
> |issue tracking|https://hbase.apache.org/issue-tracking.html|https://hbase.apache.org/issue-management.html|
> |Apache License|https://hbase.apache.org/license.html|http://www.apache.org/licenses/LICENSE-2.0|
> 2. The 'Getting Start' section in README.md contains outdated or inaccurate information:
> {code:java}
> To get started using HBase, the full documentation for this release can be found under the doc/ directory that accompanies this README. Using a browser, open the docs/index.html to view the project home page (or browse https://hbase.apache.org). The hbase 'book' has a 'quick start' section and is where you should being your exploration of the hbase project. {code}
> Maybe it should be like this:
> {code:java}
> To get started using HBase, view the project home page (https://hbase.apache.org). The hbase 'book' has a 'quick start' section and is where you should begin your exploration of the hbase project. {code}
>
> If the approach is acceptable, I'm willing to create a pull request. Please let me know if I should proceed.
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)