[
https://issues.apache.org/jira/browse/AMBARI-26668?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Arvind Kandpal updated AMBARI-26668:
------------------------------------
Description:
Several documentation files and configuration property descriptions contain
spelling mistakes, duplicated words, and one broken anchor link. This change
fixes them in one pass.
REST API docs (ambari-server/docs/api/v1):
- alert-dispatching.md: "execise" -> "exercise", "verify the the target's" ->
"verify that the target's"
- authentication-source-resources.md: "authencation"/"authentcation" ->
"authentication", "propery" -> "property", "eample" -> "example", "requirments"
-> "requirements"
- components-component.md, create-component.md: "for for" -> "for",
"identifired" -> "identified"
- configuration.md: duplicated "the the"
- host-component.md: "for a the DATANODE" -> "for the DATANODE", "the the
host" -> "the host"
- host-resources.md: "architechture" -> "architecture", "epoc" -> "epoch"
- index.md: "retrurned" -> "returned"
- schemas.md: "associateed" -> "associated"
- task-resources.md: "taks" -> "task"
- upgrades.md: "Requst" -> "Request", "specfied" -> "specified"
- user-resources.md: "is is" -> "is", "intefaces" -> "interfaces", "wheather"
-> "whether", "privilieges" -> "privileges", "propery" -> "property"
Security docs (ambari-server/docs/security):
- kerberos/kerberos_descriptor.md: broken anchor "#stack-level-configuratons"
-> "#stack-level-configurations", "identitiy" -> "identity", "reguarding" ->
"regarding", duplicated
"the the"
- kerberos/enabling_kerberos.md: duplicated "the the"
- ldap/index.md: "Synching" -> "Syncing", "attrbiute" -> "attribute", "Pyton"
-> "Python"
- sso/index.md: "servcies" -> "services"
Views docs and contrib READMEs:
- ambari-views/docs/index.md: "JavaSript" -> "JavaScript", "The class ot the
JavaBean" -> "The class of the JavaBean"
- ambari-views/examples/favorite-view/docs/index.md: "Favoriate" -> "Favorite"
- contrib/views/commons/README.md: "dependant" -> "dependent"
-
contrib/views/commons/src/main/resources/ui/hdfs-directory-viewer/README.md:
"dependant" -> "dependent", "overriden" -> "overridden"
Configuration property descriptions:
- ambari-server/docs/configuration/index.md is generated from the @Markdown
annotations in Configuration.java. Both files are fixed together so that
regenerating the docs does not
bring the typos back: "Determiens" -> "Determines", "mininum" -> "minimum",
"PostgresSQL" -> "PostgreSQL", "performanc" -> "performance".
- Property names are not changed. The key
"security.temporary.keystore.actibely.purge" keeps its current spelling,
because renaming it would break existing ambari.properties files.
This change only touches documentation text, Javadoc comments, and @Markdown
description strings. It does not change any code or behavior.
was:
ambari-server/docs/configuration/index.md is generated from the @Markdown
annotations in
ambari-server/src/main/java/org/apache/ambari/server/configuration/Configuration.java.
Several property descriptions contain spelling mistakes in both places.
Typos to fix:
- "Determiens" -> "Determines"
- "mininum" -> "minimum"
- "PostgresSQL" -> "PostgreSQL"
- "performanc" -> "performance"
The fix updates the Javadoc and @Markdown descriptions in Configuration.java
and the generated configuration/index.md together, so that regenerating the
documentation does not bring
the typos back.
Property names are not changed. The existing key
"security.temporary.keystore.actibely.purge" keeps its current spelling,
because renaming it would break existing ambari.properties
files.
> Fix typos in Ambari documentation
> ---------------------------------
>
> Key: AMBARI-26668
> URL: https://issues.apache.org/jira/browse/AMBARI-26668
> Project: Ambari
> Issue Type: Bug
> Reporter: Arvind Kandpal
> Priority: Major
>
> Several documentation files and configuration property descriptions contain
> spelling mistakes, duplicated words, and one broken anchor link. This change
> fixes them in one pass.
> REST API docs (ambari-server/docs/api/v1):
> - alert-dispatching.md: "execise" -> "exercise", "verify the the target's"
> -> "verify that the target's"
> - authentication-source-resources.md: "authencation"/"authentcation" ->
> "authentication", "propery" -> "property", "eample" -> "example",
> "requirments" -> "requirements"
> - components-component.md, create-component.md: "for for" -> "for",
> "identifired" -> "identified"
> - configuration.md: duplicated "the the"
> - host-component.md: "for a the DATANODE" -> "for the DATANODE", "the the
> host" -> "the host"
> - host-resources.md: "architechture" -> "architecture", "epoc" -> "epoch"
> - index.md: "retrurned" -> "returned"
> - schemas.md: "associateed" -> "associated"
> - task-resources.md: "taks" -> "task"
> - upgrades.md: "Requst" -> "Request", "specfied" -> "specified"
> - user-resources.md: "is is" -> "is", "intefaces" -> "interfaces",
> "wheather" -> "whether", "privilieges" -> "privileges", "propery" ->
> "property"
> Security docs (ambari-server/docs/security):
> - kerberos/kerberos_descriptor.md: broken anchor
> "#stack-level-configuratons" -> "#stack-level-configurations", "identitiy" ->
> "identity", "reguarding" -> "regarding", duplicated
> "the the"
> - kerberos/enabling_kerberos.md: duplicated "the the"
> - ldap/index.md: "Synching" -> "Syncing", "attrbiute" -> "attribute",
> "Pyton" -> "Python"
> - sso/index.md: "servcies" -> "services"
> Views docs and contrib READMEs:
> - ambari-views/docs/index.md: "JavaSript" -> "JavaScript", "The class ot
> the JavaBean" -> "The class of the JavaBean"
> - ambari-views/examples/favorite-view/docs/index.md: "Favoriate" ->
> "Favorite"
> - contrib/views/commons/README.md: "dependant" -> "dependent"
> -
> contrib/views/commons/src/main/resources/ui/hdfs-directory-viewer/README.md:
> "dependant" -> "dependent", "overriden" -> "overridden"
> Configuration property descriptions:
> - ambari-server/docs/configuration/index.md is generated from the @Markdown
> annotations in Configuration.java. Both files are fixed together so that
> regenerating the docs does not
> bring the typos back: "Determiens" -> "Determines", "mininum" -> "minimum",
> "PostgresSQL" -> "PostgreSQL", "performanc" -> "performance".
> - Property names are not changed. The key
> "security.temporary.keystore.actibely.purge" keeps its current spelling,
> because renaming it would break existing ambari.properties files.
> This change only touches documentation text, Javadoc comments, and
> @Markdown description strings. It does not change any code or behavior.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
