Skip to content
This repository was archived by the owner on Sep 12, 2018. It is now read-only.

Commit 9f3c599

Browse files
committed
Merge pull request #628 from krook/fix-markdown-typoes
Correcting typos in the {ADVANCED, CONTRIBUTING, README}.md files.
2 parents f5176a5 + 47e350e commit 9f3c599

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

ADVANCED.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
## "extras"
66

7-
The registry support additional features (that require additional dependencies) that you may require at install time.
7+
The registry supports additional features (that require additional dependencies) that you may require at install time.
88

99
### Installation
1010

1111
If you are using the official registry container, you don't need to do anything, as all extras are installed by default.
1212

13-
If you are using pip, you have to explicitely request the extra you want, using pip extra syntax:
13+
If you are using pip, you have to explicitly request the extra you want, using pip extra syntax:
1414

1515
`pip install docker-registry[someextra]`
1616

@@ -30,7 +30,7 @@ Note the bugsnag "stage" will be set to the specified configuration "flavor".
3030

3131
#### "newrelic"
3232

33-
This encapsulate your registry inside the new-relic agent.
33+
This encapsulates your registry inside the new-relic agent.
3434

3535
You need to write a new-relic ini file, then use the following environment variables:
3636

@@ -131,7 +131,7 @@ sudo yum install python-devel libevent-devel python-pip gcc xz-devel
131131
```
132132

133133
NOTE: On RHEL and CentOS you will need the
134-
[EPEL](http://fedoraproject.org/wiki/EPEL) repostitories enabled. Fedora
134+
[EPEL](http://fedoraproject.org/wiki/EPEL) repositories enabled. Fedora
135135
should not require the additional repositories.
136136

137137
Then install the Registry app:
@@ -188,9 +188,9 @@ docker run \
188188

189189
## Advanced configuration options
190190

191-
### Priviledged access
191+
### Privileged access
192192

193-
It's possible to allow priviledge access to your registry using an rsa key (useful for administration scripts for example).
193+
It's possible to allow privileged access to your registry using an RSA key (useful for administration scripts for example).
194194

195195
To do so, specify in your config:
196196

@@ -213,7 +213,7 @@ Associated public key :
213213

214214
### Email exceptions
215215

216-
Settings these options makes the Registry send an email on each code Exception:
216+
Setting these options makes the Registry send an email on each code Exception:
217217

218218
1. `email_exceptions`:
219219
1. `smtp_host`: hostname to connect to using SMTP

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ It provides:
2121

2222
* exceptions
2323
* a driver interface describing how the registry interacts with the data storage
24-
* a compatibility layer (eg: abstracting behavior differences between python versions)
24+
* a compatibility layer (e.g.: abstracting behavior differences between python versions)
2525
* common useful utility code
2626
* filesystem storage driver
2727

@@ -71,7 +71,7 @@ Drivers must stay inside `docker_registry.drivers`.
7171

7272
We use `nose`, `coverage`, `hacking` (for `flake`), `tox` and `travis`.
7373

74-
Wherever you are coding (registy, core, or driver), your friends are thus:
74+
Wherever you are coding (registry, core, or driver), your friends are thus:
7575

7676
* run the tests: `python setup.py nosetests`
7777
* check your style: `flake8`
@@ -92,7 +92,7 @@ Existing code shouldn't regress.
9292

9393
## Storage driver developer howto
9494

95-
Have a look at the [elliptics driver](https://github.com/noxiouz/docker-registry-driver-elliptics) and copy its stucture.
95+
Have a look at the [elliptics driver](https://github.com/noxiouz/docker-registry-driver-elliptics) and copy its structure.
9696

9797
Explore the files.
9898

@@ -108,7 +108,7 @@ Pretty much:
108108
Drivers are expected to receive bytes and to return bytes.
109109
Don't try to decode or encode content.
110110

111-
## Development environement notes
111+
## Development environment notes
112112

113113
We don't currently run any tests for python3, as we are stuck on gevent not being py3 ready.
114114

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Docker-Registry
66
About this document
77
===================
88

9-
As the documentation evolves with different registry versions, be sure that before reading any further you do:
9+
As the documentation evolves with different registry versions, be sure that before reading any further you:
1010

1111
* check which version of the registry you are running
1212
* switch to the corresponding tag to access the README that matches your product version
@@ -134,7 +134,7 @@ When using the `config_sample.yml`, you can pass all options through as environm
134134
1. `loglevel`: string, level of debugging. Any of python's
135135
[logging](http://docs.python.org/2/library/logging.html) module levels:
136136
`debug`, `info`, `warn`, `error` or `critical`
137-
1. `debug`: boolean, make the `/_ping` endpoint output more useful informations, such as library versions and host information.
137+
1. `debug`: boolean, make the `/_ping` endpoint output more useful information, such as library versions and host information.
138138
1. `storage_redirect`: Redirect resource requested if storage engine supports
139139
this, e.g. S3 will redirect signed URLs, this can be used to offload the
140140
server.
@@ -198,7 +198,7 @@ common:
198198
sqlalchemy_index_database: sqlite:////tmp/docker-registry.db
199199
```
200200

201-
In this case, the module is imported, and an instance of it's `Index`
201+
In this case, the module is imported, and an instance of its `Index`
202202
class is used as the search backend.
203203

204204
### Mirroring Options
@@ -228,7 +228,7 @@ to spawn a [redis-server](http://redis.io/) configured in
228228
shows an example to enable the LRU cache using the config directive `cache_lru`.
229229

230230
Once this feature is enabled, all small files (tags, meta-data) will be cached
231-
in Redis. When using a remote storage backend (like Amazon S3), it will speeds
231+
in Redis. When using a remote storage backend (like Amazon S3), it will speed
232232
things up dramatically since it will reduce roundtrips to S3.
233233

234234
All config settings are placed in a `cache` or `cache_lru` section.
@@ -250,10 +250,10 @@ To use and install one of these alternate storages:
250250

251251
* `pip install docker-registry-driver-NAME`
252252
* in the configuration set `storage` to `NAME`
253-
* add any other storage dependent configuraiton option to the conf file
253+
* add any other storage dependent configuration option to the conf file
254254
* review the storage specific documentation for additional dependency or configuration instructions.
255255

256-
Currently, we are aware of the following storage driver:
256+
Currently, we are aware of the following storage drivers:
257257

258258
* [elliptics](https://github.com/noxiouz/docker-registry-driver-elliptics)
259259
* [swift](https://github.com/bacongobbler/docker-registry-driver-swift)
@@ -333,7 +333,7 @@ For more features and advanced options, have a look at the [advanced features do
333333
For developers
334334
==============
335335

336-
Read [contribute](CONTRIBUTE.md)
336+
Read [contributing](CONTRIBUTING.md)
337337

338338
[search-endpoint]: http://docs.docker.com/reference/api/docker-io_api/#search
339339
[SQLAlchemy]: http://docs.sqlalchemy.org/

0 commit comments

Comments
 (0)