diff --git a/docs/building.md b/docs/building.md index a8c45eff3..bf62c3e29 100644 --- a/docs/building.md +++ b/docs/building.md @@ -18,11 +18,11 @@ Most people should use the [official Registry docker image](https://hub.docker.c People looking for advanced operational use cases might consider rolling their own image with a custom Dockerfile inheriting `FROM registry:2`. -OSX users who want to run natively can do so following [the instructions here](osx-setup-guide.md). +OS X users who want to run natively can do so following [the instructions here](osx-setup-guide.md). ### Gotchas -You are expected to know your way with go & git. +You are expected to know your way around with go & git. If you are a casual user with no development experience, and no preliminary knowledge of go, building from source is probably not a good solution for you. @@ -34,7 +34,7 @@ for proper setup. If done correctly, you should have a GOROOT and GOPATH set in environment. If a Go development environment is setup, one can use `go get` to install the -`registry` source code from the current latest: +`registry` command from the current latest: go get github.com/docker/distribution/cmd/registry diff --git a/docs/notifications.md b/docs/notifications.md index e6d70c845..3642a9686 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -63,7 +63,7 @@ INFO[0000] configuring endpoint alistener (https://mylistener.example.com/event) Events have a well-defined JSON structure and are sent as the body of notification requests. One or more events are sent in a structure called an -envelope. Each event has a unique id that can be used to uniquify incoming +envelope. Each event has a unique id that can be used to uniquely identify incoming requests, if required. Along with that, an _action_ is provided with a _target, identifying the object mutated during the event. diff --git a/docs/osx-setup-guide.md b/docs/osx-setup-guide.md index cd516c345..833db4117 100644 --- a/docs/osx-setup-guide.md +++ b/docs/osx-setup-guide.md @@ -1,8 +1,8 @@ @@ -10,21 +10,21 @@ keywords = ["registry, on-prem, images, tags, repository, distribution, osx, rec ## Use-case -This is useful if you intend to run a registry server natively on OSX. +This is useful if you intend to run a registry server natively on OS X. ### Alternatives -You can start a VM on OSX, and deploy your registry normally as a container using Docker inside that VM. +You can start a VM on OS X, and deploy your registry normally as a container using Docker inside that VM. The simplest road to get there is traditionally to use the [docker Toolbox](https://www.docker.com/toolbox), or [docker-machine](https://docs.docker.com/machine/), which usually relies on the [boot2docker](http://boot2docker.io/) iso inside a VirtualBox VM. ### Solution -Using the method described here, you install and compile your own from the git repository and run it as an OSX agent. +Using the method described here, you install and compile your own from the git repository and run it as an OS X agent. ### Gotchas -Production services operation on OSX is out of scope of this document. Be sure you understand well these aspects before considering going to production with this. +Production services operation on OS X is out of scope of this document. Be sure you understand well these aspects before considering going to production with this. ## Setup golang on your machine diff --git a/docs/recipes.md b/docs/recipes.md index b2a69db10..1dab46a03 100644 --- a/docs/recipes.md +++ b/docs/recipes.md @@ -30,6 +30,6 @@ At this point, it's assumed that: * [using Apache as an authenticating proxy](apache.md) * [using Nginx as an authenticating proxy](nginx.md) - * [running a Registry on OSX](osx-setup-guide.md) + * [running a Registry on OS X](osx-setup-guide.md) * [hacking the registry: build instructions](building.md) * [mirror the Docker Hub](mirror.md) \ No newline at end of file