[
https://issues.apache.org/jira/browse/YETUS-80?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15400079#comment-15400079
]
Allen Wittenauer commented on YETUS-80:
---------------------------------------
Awesome. Thanks!
Some comments after a first pass:
* the TOC macro is used by mvn site, so doesn't work here.
* "classification provided here" -> should probably be "classification provided
by Apache Yetus audience annotations"
* "Yetus adopts the following" -> "Yetus provides the following" ... given
that Yetus doesn't really have a Java interface... :)
* The OpenSolaris link is dead, apparently. Here's a web archive link
(http://web.archive.org/web/20061013114610/http://opensolaris.org/os/community/arc/policies/interface-taxonomy/),
but it would better to have a real one. Illumos probably doesn't have the
equivalent of PSARC so may not have this particular document saved off. :(
[Sidenote: The 3.1 changes are particularly interesting. We may want to
investigate adding them here.]
* "Yetus doesn’t have a Company-Private classification" .. let's drop this
section for now. We do need to add it at some point.
* "internal use within the project (such as HDFS or MapReduce) " -> "internal
use within a project (such as Apache Hadoop)"
* "in the Hadoop project" -> "in the Apache Hadoop project"
* "HDFS and MapReduce projects" -> "HDFS and MapReduce subprojects"
* "Yetus APIs have the" -> "Yetus provides the"
* "APIs marked Stable are allowed only" -> "APIs marked Stable are generally
only allowed"
* "How will the classification be recorded for the annotated APIs?" -> "How
should the classification be recorded for annotated APIs?"
* "BlockLocations in Hadoop Project" -> " BlockLocations in the Apache Hadoop
project"
* " interface that we are willing" -> " interface that they are willing" ... a
few more we's that should be they's in the same paragraph and in a few other
places where they are talking about things specific to Hadoop.
* "Hadoop family " -> "Apache Hadoop extended ecosystem"
* "Lets treat all private interfaces as project-private." ... This paragraph
should probably just be rewritten.
One other thing:
This needs to be linked from the parent page.
> update missing docs from Hadoop
> -------------------------------
>
> Key: YETUS-80
> URL: https://issues.apache.org/jira/browse/YETUS-80
> Project: Yetus
> Issue Type: Task
> Components: website and documentation
> Affects Versions: 0.1.0
> Reporter: Sean Busbey
> Assignee: Ajay Yadava
> Attachments: YETUS-80.00.patch, YETUS-80.01.patch
>
>
> per [~aw] on YETUS-3:
> {quote}
> Add parts of the Hadoop's interface classification documentation into our
> docs. We need this for shelldocs too (which currently lacks documentation).
> {quote}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
