Merge pull request #5269 from ostezer/docs-improve-index-docs

Improve (&restructure) Docker Index docs on the Docker docs.

docs/mkdocs.yml

@@ -82,6 +82,13 @@ pages:
 # - ['user-guide/configuration.md', 'User Guide', 'Configuration']
 # ./faq.md
 
+# Docker Index docs:
+- ['index/index.md', '**HIDDEN**']
+# - ['index/home.md', 'Docker Index', 'Help']
+- ['index/home.md', 'Docker Index', 'Accounts']
+- ['index/home.md', 'Docker Index', 'Repositories']
+- ['index/home.md', 'Docker Index', 'Trusted Builds']
+
 # Reference
 - ['reference/index.md', '**HIDDEN**']
 - ['reference/commandline/cli.md', 'Reference', 'Command line']
@@ -106,11 +113,6 @@ pages:
 - ['contributing/devenvironment.md', 'Contribute', 'Development environment']
 # - ['about/license.md', 'About', 'License']
 
-# Docker Index docs:
-- ['index/index.md', '**HIDDEN**']
-- ['index/home.md', 'Docker Index', 'Help']
-- ['index/docs.md', 'Docker Index', 'Documentation']
-
 - ['jsearch.md', '**HIDDEN**']
 
 # - ['static_files/README.md', 'static_files', 'README']

docs/sources/index/accounts.md

@@ -0,0 +1,31 @@
+page_title: Accounts in the Docker Index
+page_description: Docker Index accounts
+page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation
+
+# Accounts in the Docker Index
+
+## Docker IO and Docker Index Accounts
+
+You can `search` for Docker images and `pull` them from the [Docker Index]
+(https://index.docker.io) without signing in or even having an account. However,
+in order to `push` images, leave comments or to *star* a repository, you are going
+to need a [Docker IO](https://www.docker.io) account.
+
+### Registration for a Docker IO Account
+
+You can get a Docker IO account by [signing up for one here]
+(https://index.docker.io/account/signup/). A valid email address is required to
+register, which you will need to verify for account activation.
+
+### Email activation process
+
+You need to have at least one verified email address to be able to use your
+Docker IO account. If you can't find the validation email, you can request
+another by visiting the [Resend Email Confirmation]
+(https://index.docker.io/account/resend-email-confirmation/) page.
+
+### Password reset process
+
+If you can't access your account for some reason, you can reset your password
+from the [*Password Reset*](https://www.docker.io/account/forgot-password/)
+page.

docs/sources/index/builds.md

@@ -1,126 +1,8 @@
-page_title: The Documentation
+page_title: Trusted Builds in the Docker Index
-page_description: The Docker Index help documentation
+page_description: Docker Index Trusted Builds
-page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation
+page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation, trusted, builds, trusted builds
 
-# The Documentation
+# Trusted Builds in the Docker Index
-
-## Docker IO and Docker Index Accounts
-
-You can `search` for Docker images and `pull` them from the [Docker Index]
-(https://index.docker.io) without signing in or even having an account. However,
-in order to `push` images, leave comments or to *star* a repository, you are going
-to need a [Docker IO](https://www.docker.io) account.
-
-### Registration for a Docker IO Account
-
-You can get a Docker IO account by [signing up for one here]
-(https://index.docker.io/account/signup/). A valid email address is required to
-register, which you will need to verify for account activation.
-
-### Email activation process
-
-You need to have at least one verified email address to be able to use your
-Docker IO account. If you can't find the validation email, you can request
-another by visiting the [Resend Email Confirmation]
-(https://index.docker.io/account/resend-email-confirmation/) page.
-
-### Password reset process
-
-If you can't access your account for some reason, you can reset your password
-from the [*Password Reset*](https://www.docker.io/account/forgot-password/)
-page.
-
-## Searching for repositories and images
-
-You can `search` for all the publicly available repositories and images using
-Docker. If a repository is not public (i.e., private), it won't be listed on
-the Index search results. To see repository statuses, you can look at your
-[profile page](https://index.docker.io/account/).
-
-## Repositories
-
-### Stars
-
-Stars are a way to show that you like a repository. They are also an easy way
-of bookmark your favorites.
-
-### Comments
-
-You can interact with other members of the Docker community and maintainers by
-leaving comments on repositories. If you find any comments that are not
-appropriate, you can flag them for the Index admins' review.
-
-### Private Docker Repositories
-
-To work with a private repository on the Docker Index, you will need to add one
-via the [Add Repository](https://index.docker.io/account/repositories/add) link.
-Once the private repository is created, you can `push` and `pull` images to and
-from it using Docker.
-
-> *Note:* You need to be signed in and have access to work with a private
-> repository.
-
-Private repositories are just like public ones. However, it isn't possible to
-browse them or search their content on the public index. They do not get cached
-the same way as a public repository either.
-
-It is possible to give access to a private repository to those whom you 
-designate (i.e., collaborators) from its settings page.
-
-From there, you can also switch repository status (*public* to *private*, or
-viceversa). You will need to have an available private repository slot open
-before you can do such a switch. If you don't have any, you can always upgrade
-your [Docker Index plan](https://index.docker.io/plans/).
-
-### Collaborators and their role
-
-A collaborator is someone you want to give access to a private repository. Once
-designated, they can `push` and `pull`. Although, they will not be allowed to
-perform any administrative tasks such as deleting the repository or changing its
-status from private to public.
-
-> **Note:** A collaborator can not add other collaborators. Only the owner of
-> the repository has administrative access.
-
-### Webhooks
-
-You can configure webhooks on the repository settings page. A webhook is called
-only after a successful `push` is made. The webhook calls are HTTP POST requests
-with a JSON payload similar to the example shown below.
-
-> **Note:** For testing, you can try an HTTP request tool like
-> [requestb.in](http://requestb.in/).
-
-*Example webhook JSON payload:*
-
-    {
-       "push_data":{
-          "pushed_at":1385141110,
-          "images":[
-             "imagehash1",
-             "imagehash2",
-             "imagehash3"
-          ],
-          "pusher":"username"
-       },
-       "repository":{
-          "status":"Active",
-          "description":"my docker repo that does cool things",
-          "is_trusted":false,
-          "full_description":"This is my full description",
-          "repo_url":"https://index.docker.io/u/username/reponame/",
-          "owner":"username",
-          "is_official":false,
-          "is_private":false,
-          "name":"reponame",
-          "namespace":"username",
-          "star_count":1,
-          "comment_count":1,
-          "date_created":1370174400,
-          "dockerfile":"my full dockerfile is listed here",
-          "repo_name":"username/reponame"
-       }
-    }
 
 ## Trusted Builds
 
@@ -233,4 +115,4 @@ linked.
 
 > **Warning:** You can add more than one repository link, however, you should
 > be very careful. Creating a two way relationship between Trusted Builds will
-> cause a never ending build loop.
+> cause a never ending build loop.

docs/sources/index/repos.md

@@ -0,0 +1,97 @@
+page_title: Repositories and Images in the Docker Index
+page_description: Docker Index repositories
+page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation
+
+# Repositories and Images in the Docker Index
+
+## Searching for repositories and images
+
+You can `search` for all the publicly available repositories and images using
+Docker. If a repository is not public (i.e., private), it won't be listed on
+the Index search results. To see repository statuses, you can look at your
+[profile page](https://index.docker.io/account/).
+
+## Repositories
+
+### Stars
+
+Stars are a way to show that you like a repository. They are also an easy way
+of bookmark your favorites.
+
+### Comments
+
+You can interact with other members of the Docker community and maintainers by
+leaving comments on repositories. If you find any comments that are not
+appropriate, you can flag them for the Index admins' review.
+
+### Private Docker Repositories
+
+To work with a private repository on the Docker Index, you will need to add one
+via the [Add Repository](https://index.docker.io/account/repositories/add) link.
+Once the private repository is created, you can `push` and `pull` images to and
+from it using Docker.
+
+> *Note:* You need to be signed in and have access to work with a private
+> repository.
+
+Private repositories are just like public ones. However, it isn't possible to
+browse them or search their content on the public index. They do not get cached
+the same way as a public repository either.
+
+It is possible to give access to a private repository to those whom you 
+designate (i.e., collaborators) from its settings page.
+
+From there, you can also switch repository status (*public* to *private*, or
+viceversa). You will need to have an available private repository slot open
+before you can do such a switch. If you don't have any, you can always upgrade
+your [Docker Index plan](https://index.docker.io/plans/).
+
+### Collaborators and their role
+
+A collaborator is someone you want to give access to a private repository. Once
+designated, they can `push` and `pull`. Although, they will not be allowed to
+perform any administrative tasks such as deleting the repository or changing its
+status from private to public.
+
+> **Note:** A collaborator can not add other collaborators. Only the owner of
+> the repository has administrative access.
+
+### Webhooks
+
+You can configure webhooks on the repository settings page. A webhook is called
+only after a successful `push` is made. The webhook calls are HTTP POST requests
+with a JSON payload similar to the example shown below.
+
+> **Note:** For testing, you can try an HTTP request tool like
+> [requestb.in](http://requestb.in/).
+
+*Example webhook JSON payload:*
+
+    {
+       "push_data":{
+          "pushed_at":1385141110,
+          "images":[
+             "imagehash1",
+             "imagehash2",
+             "imagehash3"
+          ],
+          "pusher":"username"
+       },
+       "repository":{
+          "status":"Active",
+          "description":"my docker repo that does cool things",
+          "is_trusted":false,
+          "full_description":"This is my full description",
+          "repo_url":"https://index.docker.io/u/username/reponame/",
+          "owner":"username",
+          "is_official":false,
+          "is_private":false,
+          "name":"reponame",
+          "namespace":"username",
+          "star_count":1,
+          "comment_count":1,
+          "date_created":1370174400,
+          "dockerfile":"my full dockerfile is listed here",
+          "repo_name":"username/reponame"
+       }
+    }