Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
antoniivanov authored Aug 30, 2023
1 parent e3442ce commit 98471d8
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions specs/vep-2420-getting-started-with-my-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,14 @@ In our tutorials we encourage users to set ingest destination using env variable
2. Sections in the ini are simplified or config.ini is deprecated in favour of setting more properties in python or using a newer file format
3. At the start of this initiative we ran user interviews asking users to read from postgres and write to sqlite. When the user interviews are run at the end of this initiative, users not only know which properties to set but be able to give a good explanation of what thosee properties do
4. In getting started examples the destination database should be set at a single property and not need to be duplicated twice as is the case now
2. Users should feel that they have written a production ready job
2. Easily finding out which SDK functionality and method are needed for a given task
1. Ensure documentation reference is available that can serve as a quick reference for SDK functionalities
2. Provide users with capability to auto generate boilerplate code customized according to their requirements and needs.
4. Users should feel that they have written a production ready job
1. All the jobs written during the previous user test would not have been fit to deploy to production because there are secrets in the user code. When the user interviews are run at the end of this initiative, users should have produced jobs that are sutible to deploy to production.
3. Env variables are supported but not advertised as the primary method of setting properties
5. Env variables are supported but not advertised as the primary method of setting properties
1. No getting started sections will suggest setting env variables. (arguably this is change should be part of the docs initiative)
4. IDE support should be more adopted
6. IDE support should be more adopted
1. When the user interviews are run at the end of this initiative, users should run it in their IDE without being mandated to do so. But a small bit of encouragement is fine.

### Out of scope because they are handled else where
Expand Down

0 comments on commit 98471d8

Please sign in to comment.