Open eclarke1 opened 3 years ago
@felixarntz @aaemnnosttv @marrrmarrr this was one of the 4 articles voted highest priority by engineers so if possible to progress this through the workflow along with the others labelled 'Type: Docs' and have P1 assigned.
@eugene-manuilov IB mostly looks good, however I have one concern:
and explain in detail how createFetchStore works and how users can create their own fetch stores
This should be part of the referenced "Data store architecture" docs instead. The article here should focus more on high-level concepts and doesn't need to go into actual code as much - it's the first article in the Architecture section, so it's more important to explain the flow, the relationships of different pieces, maybe naming conventions, etc. We don't need to cover how exactly to write the client-side and server-side parts of an endpoint here - it's okay to use code pointers, but the article itself shouldn't focus on code.
Other than this one point, I think the outline looks solid.
@felixarntz, IB is updated. Does it look better?
@eugene-manuilov Looks good, IB ✅
@tofumatt left a few comments here but overall I think it's good to go. I'm also happy for someone else to give it a final look over to not be a blocker here if you'd like, but this can probably also be a quick final review from me before merging.
Feature Description
Do not alter or remove anything below. The following sections will be managed by moderators only.
Acceptance criteria
Implementation Brief
Instead of a regular IB, please provide your proposed document outline (nested list of headings) for the article here. Use headings that the article could actually use, not just some brainstorm type of preliminary heading. Please assign to @felixarntz for IB review, specifically since this is one of the first articles in the epic.
createFetchStore
, so users know where to look at when they need to create their own fetch store.get_datapoint_definitions
,create_data_request
,parse_data_response
) and for the core (using customREST_Route
instances). Tell how to define required scopes for module endpoints and how to prevent insecure access to endpoints._setup_services
method and how to use it to call Google API in the module endpoints._Test Coverage
QA Brief
Changelog entry