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

Commit 0aa7dfd

Browse files
committed
README.md: Restore SQLAlchemy docs and links
The explanation for sqlalchemy_index_database was removed in bb69c43 (update documentation for config_sample.yml changes, 2014-05-14), and the reference URL for search-endpoint was removed in 4ba12e5 (Updated documentation for 0.7, new developer (contribute) doc, new changelog file, 2014-05-20). Since I added the links in fab832b (search: Use SQLAlchemy as a search-index backend, 2014-02-12), the search-endpoint URL has moved from: http://docs.docker.io/en/latest/reference/api/index_api/#get--v1-search to: http://docs.docker.com/reference/api/docker-io_api/#search But I haven't tracked down the Docker-side commit responsible for that move.
1 parent 80459cd commit 0aa7dfd

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

CONTRIBUTE.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,3 @@ Pretty much:
103103

104104
Drivers are expected to receive bytes and to return bytes.
105105
Don't try to decode or encode content.
106-
107-
## API documentation
108-
109-
[search-endpoint]:
110-
http://docs.docker.io/en/latest/reference/api/index_api/#get--v1-search
111-
[SQLAlchemy]: http://docs.sqlalchemy.org/
112-
[create_engine]:
113-
http://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,6 @@ returns empty results.
209209
Currently supported backends are:
210210
1. `sqlalchemy`
211211
212-
213212
If `search_backend` is neither empty nor one of the supported backends, it
214213
should point to a module.
215214
@@ -222,7 +221,10 @@ common:
222221

223222
#### sqlalchemy
224223

225-
1. `sqlalchemy_index_database`: The database URL
224+
Use [SQLAlchemy][] as the search backend.
225+
226+
1. `sqlalchemy_index_database`: The database URL passed through to
227+
[create_engine][].
226228

227229
Example:
228230

@@ -232,7 +234,6 @@ common:
232234
sqlalchemy_index_database: sqlite:////tmp/docker-registry.db
233235
```
234236
235-
236237
In this case, the module is imported, and an instance of it's `Index`
237238
class is used as the search backend.
238239

@@ -494,3 +495,8 @@ For developers
494495
--------------
495496
496497
Read CONTRIBUTE.md
498+
499+
[search-endpoint]: http://docs.docker.com/reference/api/docker-io_api/#search
500+
[SQLAlchemy]: http://docs.sqlalchemy.org/
501+
[create_engine]:
502+
http://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine

0 commit comments

Comments
 (0)