[Database metrics] Add start of README #36
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dfarrow0
reviewed
Nov 16, 2020
| This module contains methods for collecting metrics on the database server under different conditions. | ||
|
|
||
| ## Usage | ||
| 1. Using the [Docker tutorials](https://github.com/cmu-delphi/delphi-epidata/blob/main/docs/epidata_development.md), |
There was a problem hiding this comment.
the backend guide might be more direct than the epidata guide (since the latter points to the former), but up to you
link to backend guide: https://github.com/cmu-delphi/operations/blob/main/docs/backend_development.md
There was a problem hiding this comment.
(nevermind, i see you use the web and database images below -- pls disregard)
There was a problem hiding this comment.
👍 btw, those guides were super useful.
There was a problem hiding this comment.
thanks :D glad to hear that
dfarrow0
reviewed
Nov 16, 2020
src/database_metrics/README.md
Outdated
| b. Add `COPY common_full common_full` to `repos/delphi/operations/dev/docker/python/Dockerfile` after copying source files. | ||
| 4. Continue with the tutorial to complete the following steps: | ||
| a. Build the `delphi_web`, `delphi_web_epidata`, `delphi_database`, and `delphi_python` images according to the tutorial. | ||
| b. Start the `delphi-net` network according to the tutorial. |
There was a problem hiding this comment.
small nit: you shouldn't have to do anything to start the network. did you maybe mean "create" instead of "start"?
There was a problem hiding this comment.
Good catch, edited to create
dfarrow0
approved these changes
Nov 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of Changes:
There is still work to do once the final interface is determined, which is tracked in #35