Skip to content

Commit c311d0e

Browse files
committed
docs: improve readability
1 parent 1375d90 commit c311d0e

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -270,10 +270,17 @@ The following parameters can be set in the config file or via env variables:
270270
271271
When we add, update or delete models and/or endpoints we have to make sure that we keep documentation and utility scripts up to date.
272272
273-
- Update Swagger.
274-
- Update Postman.
275-
- Update mapping definitions for ElasticSearch indexes inside this repository and inside [taas-es-processor](https://github.com/topcoder-platform/taas-es-processor) repository.
276-
- NPM command `index:all` should re-index data in all ES indexes. And there should be an individual NPM command `index:*` which would re-index data only in one ES index.
277-
- NPM commands `data:import` and `data:export` should support importing/exporting data from/to all the models.
278-
- NPM commands `create-index` and `delete-index` should support creating/deleting all the indexes.
279-
- If there are any updates in DB schemas, create a DB migration script inside `migrations` folder which would make any necessary updates to the DB schema. Test, that when we migrate DB from the previous state using `npm run migrate`, we get the same exactly the same DB schema as if we create DB from scratch using command `npm run init-db force`.
273+
- **Swagger**
274+
- **Postman**
275+
- **ES Mapping**
276+
- Update mapping definitions for ElasticSearch indexes inside both repositories [taas-apis](https://github.com/topcoder-platform/taas-apis) and [taas-es-processor](https://github.com/topcoder-platform/taas-es-processor).
277+
- **Reindex**
278+
- NPM command `index:all` should re-index data in all ES indexes.
279+
- There should be an individual NPM command `index:*` which would re-index data only in one ES index.
280+
- **Import/Export**
281+
- NPM commands `data:import` and `data:export` should support importing/exporting data from/to all the models.
282+
- **Create/Delete Index**
283+
- NPM commands `create-index` and `delete-index` should support creating/deleting all the indexes.
284+
- **DB Migration**
285+
- If there are any updates in DB schemas, create a DB migration script inside `migrations` folder which would make any necessary updates to the DB schema.
286+
- Test, that when we migrate DB from the previous state using `npm run migrate`, we get exactly the same DB schema as if we create DB from scratch using command `npm run init-db force`.

0 commit comments

Comments
 (0)