Comments (4)
I am not sure... I think my general sense is that READMEs are good if you need to interface with the code. If you just want to 'use' the code, then you shouldn't have to look inside a source code repository for information. I think if you imagine READMEs as being consumed from inside an IDE the distinction becomes clearer...
from data-models.
That's a nice way to frame it.
I think I need to mull it over but setting a different config to the default does feel like it's in that territory - maybe you're not changing code but you're digging in to the level that you'd probably be looking at the SQL in depth.
Some other things, however, could probably be best shipped to docs site and removed from repo.
I'll mull this over. Thanks for the input.
from data-models.
I think the wider question is, what are the READMEs trying to deliver that can't be better homed on the docs site?
from data-models.
Fair point @alexanderdean - we ended up here because we hadn't had docs written yet when the readmes were created. We used the readmes as basis for docs.
If I'm ignoring that sequence of events - I think there's an argument that right now, it makes more sense to have these specific things in READMEs and have docs only worry about the basic settings. Everything beyond the basics has a default which will only need attention when you're digging into the plumbing of the model.
I plan on discussing with product to iron it out regardless.
I'm curious as to your general opinion about this repo - personally I feel there are a lot of readmes and there's a lot of information to consume (which is hard to avoid with a lot of complexity to explain). What's your view?
from data-models.
Related Issues (20)
- Introduce start_tstamp in events_this_run / events_staged HOT 2
- Add stored procedures to more automatically generate custom event-level tables HOT 3
- Rename Snowplow Insights to Snowplow BDP
- Add backfill functionality HOT 3
- All models: Fix logic in users_sessions_this_run to account for sparse data HOT 1
- Snowflake web: Fix logic in users_sessions_this_run to account for sparse data
- All Redshift and Snowflake models: Fix varchar length for pseudonymized fields
- Snowflake web: Fix varchar length for pseudonymized fields
- Snowflake web: Remove start_date variable from users module
- Snowflake Web: Update copyright notices
- Snowflake web: Update column check stored procedure
- Update Readme HOT 1
- All models, base module: Fail with a warning when there's no data
- Redshift web: Change SORTKEY encoding to RAW
- Redshift Web: Fix column lengths in manifest tables
- Add migrations for previous releases
- Redshift Web: load_tstamp missing from table definition
- Redshift Mobile: load_tstamp missing from table definition
- Update dbt section within readme
- Snowflake Web: Optimise partition pruning HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from data-models.