docs: Improve docs for new contributors #1038
Conversation
This collects various improvements and pointers from someone getting started with Merino.
|
@tiftran Heh, thanks, but not quite done yet. (Ideally, there should be a test framework in here as well.) I'll convert from draft once it's ready to go and add reviewers. Thanks for the drive-by! |
…s/DISCO-3666_startup_guide
Better understanding of the Data models, manifests, and code structures.
Herraj
left a comment
Herraj
left a comment
There was a problem hiding this comment.
I noticed a few TODOs but otherwise looking good! Easy to understand and follow and concise wording!
| - `development.toml`, etc. - The platform specific configurations to use. These will eventually be replaced by a single, composed `platform.toml`(name TBD). | ||
|
|
||
| Validators for the configuration options are stored in the `./merino/configs/__init__.py` file | ||
|
|
There was a problem hiding this comment.
(suggestion): we should also add that we use (create it locally first) a default.local.toml in merino/configs which is used by the locally running instance of merino via make dev.
default.local.toml is where we store the actual api keys for vendors like accuweather / polygon e.t.c to test against the live endpoints from our local machine. Configs in this file will override configs from default.toml. And, this config file is in the .gitignore so it'll prevent you from committing secrets 😄
There was a problem hiding this comment.
Oh, Cool! I didn't know about that. Thanks!
|
Crap, just saw I had marked this ready for review. It's not. Reverting to draft. |
Add the Sports Data suggestion provider, as well as the merino data injestion job. Closes: DISCO-3666
…s/DISCO-3666_startup_guide
…s/DISCO-3666_startup_guide
…s/DISCO-3666_startup_guide
|
Ok, post sports updates added, and a bit of clean-up / simplification. |
This collects various improvements and pointers from someone getting started with Merino.
References
JIRA: DISCO-3666
Description
This collects various improvements and pointers from someone getting started with Merino.
PR Review Checklist
Put an
xin the boxes that apply[DISCO-####], and has the same title (if applicable)[load test: (abort|skip|warn)]keywords are applied to the last commit message (if applicable)┆Issue is synchronized with this Jira Task