Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-24809 Fix broken Apache Yetus documentation links 

Closes #2335

Signed-off-by: Viraj Jasani <vjasani@apache.org>
This commit is contained in:
Abhey 2020-08-31 20:52:52 +05:30 committed by Viraj Jasani
parent 25fcc40f6a
commit 979edfe720
No known key found for this signature in database
GPG Key ID: B3D6C0B41C8ADFD5
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dev-support/HOW_TO_YETUS_LOCAL.md
View File

@ -181,5 +181,5 @@ $ test-patch.sh \
[maven]: https://maven.apache.org [maven]: https://maven.apache.org
[spotbugs]: https://spotbugs.github.io [spotbugs]: https://spotbugs.github.io
[yetus]: https://yetus.apache.org [yetus]: https://yetus.apache.org
[yetus-basic-precommit]: https://yetus.apache.org/documentation/0.11.1/precommit-basic/ [yetus-basic-precommit]: https://yetus.apache.org/documentation/in-progress/precommit-basic/
[yetus-downloads]: https://yetus.apache.org/downloads/ [yetus-downloads]: https://yetus.apache.org/downloads/

6
src/main/asciidoc/_chapters/upgrading.adoc
View File

@ -131,14 +131,14 @@ Previously, we tried to maintain dependency compatibility for the underly Hadoop
[[hbase.client.api.surface]] [[hbase.client.api.surface]]
==== HBase API Surface ==== HBase API Surface
HBase has a lot of API points, but for the compatibility matrix above, we differentiate between Client API, Limited Private API, and Private API. HBase uses link:https://yetus.apache.org/documentation/0.5.0/interface-classification/[Apache Yetus Audience Annotations] to guide downstream expectations for stability. HBase has a lot of API points, but for the compatibility matrix above, we differentiate between Client API, Limited Private API, and Private API. HBase uses link:https://yetus.apache.org/documentation/in-progress/interface-classification/[Apache Yetus Audience Annotations] to guide downstream expectations for stability.
* InterfaceAudience (link:https://yetus.apache.org/documentation/0.5.0/audience-annotations-apidocs/org/apache/yetus/audience/InterfaceAudience.html[javadocs]): captures the intended audience, possible values include: * InterfaceAudience (link:https://yetus.apache.org/documentation/in-progress/javadocs/org/apache/yetus/audience/InterfaceAudience.html[javadocs]): captures the intended audience, possible values include:
- Public: safe for end users and external projects - Public: safe for end users and external projects
- LimitedPrivate: used for internals we expect to be pluggable, such as coprocessors - LimitedPrivate: used for internals we expect to be pluggable, such as coprocessors
- Private: strictly for use within HBase itself - Private: strictly for use within HBase itself
Classes which are defined as `IA.Private` may be used as parameters or return values for interfaces which are declared `IA.LimitedPrivate`. Treat the `IA.Private` object as opaque; do not try to access its methods or fields directly. Classes which are defined as `IA.Private` may be used as parameters or return values for interfaces which are declared `IA.LimitedPrivate`. Treat the `IA.Private` object as opaque; do not try to access its methods or fields directly.
* InterfaceStability (link:https://yetus.apache.org/documentation/0.5.0/audience-annotations-apidocs/org/apache/yetus/audience/InterfaceStability.html[javadocs]): describes what types of interface changes are permitted. Possible values include: * InterfaceStability (link:https://yetus.apache.org/documentation/in-progress/javadocs/org/apache/yetus/audience/InterfaceStability.html[javadocs]): describes what types of interface changes are permitted. Possible values include:
- Stable: the interface is fixed and is not expected to change - Stable: the interface is fixed and is not expected to change
- Evolving: the interface may change in future minor verisons - Evolving: the interface may change in future minor verisons
- Unstable: the interface may change at any time - Unstable: the interface may change at any time