Sfoglia il codice sorgente

HDDS-1733. Fix Ozone documentation (#1031)

dineshchitlangia 5 anni fa
parent
commit
da568996af

+ 3 - 3
hadoop-hdds/docs/content/_index.md

@@ -34,11 +34,11 @@ ref "JavaApi.md"
 >}}), [S3 protocol support] ({{< ref "S3.md" >}}), and a [command line interface]
 ({{< ref "shell/_index.md" >}})  which makes it easy to use Ozone.
 
-Ozone consists of volumes, buckets, and Keys:
+Ozone consists of volumes, buckets, and keys:
 
 * Volumes are similar to user accounts. Only administrators can create or delete volumes.
-* Buckets are similar to directories. A bucket can contain any number of keys,  but buckets cannot contain other buckets.
-* Keys are similar to files. A bucket can contain any number of keys.
+* Buckets are similar to directories. A bucket can contain any number of keys, but buckets cannot contain other buckets.
+* Keys are similar to files.
 
  <a href="{{< ref "start/_index.md" >}}"> <button type="button"
  class="btn  btn-success btn-lg">Next >></button>

+ 2 - 1
hadoop-hdds/docs/content/beyond/Containers.md

@@ -202,7 +202,7 @@ Ozone related container images and source locations:
       <td>docker-hadoop-runner</td>
       <td>centos</td>
       <td>jdk11,jdk8,latest</td>
-       <td>This is the base image used for testing Hadoop Ozone.
+      <td>This is the base image used for testing Hadoop Ozone.
        This is a set of utilities that make it easy for us run ozone.</td>
     </tr>
     <tr>
@@ -211,6 +211,7 @@ Ozone related container images and source locations:
       <td>https://github.com/apache/hadoop-docker-ozone</td>
       <td>ozone-build </td>
       <td> </td>
+      <td> </td>
       <td>TODO: Add more documentation here.</td>
     </tr>
   </tbody>

+ 1 - 1
hadoop-hdds/docs/content/recipe/Prometheus.md

@@ -81,7 +81,7 @@ http://localhost:9090/targets
 
 http://localhost:9090/graph?g0.range_input=1h&g0.expr=om_metrics_num_key_allocate&g0.tab=1
 
-![Prometheus target page example](prometheus-key-allocate.png)
+![Prometheus metrics page example](prometheus-key-allocate.png)
 
 ## Note
 

+ 0 - 0
hadoop-hdds/docs/static/prometheus-key-allocate.png → hadoop-hdds/docs/content/recipe/prometheus-key-allocate.png


+ 0 - 0
hadoop-hdds/docs/static/prometheus.png → hadoop-hdds/docs/content/recipe/prometheus.png


+ 8 - 8
hadoop-hdds/docs/content/start/_index.md

@@ -38,7 +38,7 @@ Kubernetes or bare-metal.
 <h2>Running Ozone from Docker Hub</h2>
 
 You can try out Ozone using docker hub without downloading the official release. This makes it easy to explore Ozone.
-
+<br />
   {{<card title="Starting ozone inside a single container" link="start/StartFromDockerHub.md" link-text="Ozone In Docker" image="start/docker.png">}}
   The simplest and easiest way to start an ozone cluster
       to explore what it can do is to start ozone via docker.
@@ -54,21 +54,21 @@ You can try out Ozone using docker hub without downloading the official release.
 <h2>Running Ozone from an Official Release</h2>
 
  Apache Ozone can also be run from the official release packages. Along with the official source releases, we also release a set of convenience binary packages. It is easy to run these binaries in different configurations.
-
-  {{<card title="Deploying Ozone on a physical cluster" link="start/OnPrem" link-text="On-Prem Ozone Cluster" image="start/hadoop.png">}}
+<br />
+  {{<card title="Ozone on a physical cluster" link="start/OnPrem" link-text="On-Prem Ozone Cluster" image="start/hadoop.png">}}
 Ozone is designed to work concurrently with HDFS. The physical cluster instructions explain each component of Ozone and how to deploy with maximum control.
   {{</card>}}
 
-  {{<card title="Deploying Ozone on K8s" link="start/Kubernetes" link-text="Kubernetes" image="start/k8s.png">}}
-Ozone is designed to work well under Kubernetes. These are instructions on how to deploy Ozone on K8s platform. Ozone provides a replicated storage solution for K8s based Applications.
+  {{<card title="Ozone on K8s" link="start/Kubernetes" link-text="Kubernetes" image="start/k8s.png">}}
+Ozone is designed to work well under Kubernetes. These are instructions to deploy Ozone on K8s. Ozone provides a replicated storage solution for K8s based apps.
   {{</card>}}
 
-  {{<card title="Deploy Ozone using MiniKube" link="start/Minikube" link-text="Minikube cluster" image="start/minikube.png">}}
+  {{<card title="Ozone using MiniKube" link="start/Minikube" link-text="Minikube cluster" image="start/minikube.png">}}
 Ozone comes with a standard set of K8s resources. You can deploy them to MiniKube and experiment with the K8s based deployments.
   {{</card>}}
 
-  {{<card title="An Ozone cluster in Local Node." link="start/RunningViaDocker.md" link-text="docker-compose" image="start/docker.png">}}
- We also ship standard docker files with official release, if you want to use them. These are part of official release and not depend upon Docker Hub.
+  {{<card title="Ozone cluster in Local Node" link="start/RunningViaDocker.md" link-text="docker-compose" image="start/docker.png">}}
+ We also ship standard docker files with official release. These are part of official release and not depend upon Docker Hub.
   {{</card>}}
 
 </section>