docs: Reorganize data source information #1425
Conversation
|
Deploy preview for docs ready! ✅ Preview Built with commit a29b1b7. |
tzjames
changed the title
| @@ -30,6 +30,7 @@ const config = { | |||
| /** @type {import('@docusaurus/preset-classic').Options} */ | |||
| ({ | |||
| docs: { | |||
| breadcrumbs: true, | |||
There was a problem hiding this comment.
Perhaps it wasn't so helpful before as there was just two layers, but now there is more.
| .menu__list { | ||
| .menu__link--sublist { | ||
| margin-inline-start: calc( | ||
| -1 * (var(--dropdown-icon-width) + var(--dropdown-icon-gap)) | ||
| ); | ||
|
|
||
| &::after { | ||
| opacity: 0.6; | ||
| } | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
I believe this was copied from what we had before docusaurus. It messes up the indents of the new drop downs within drop downs. It didn't apply to any nodes before this change.
docs/docs/app/datasources.mdx
Outdated
|
|
||
| #### Predefined Schemas | ||
| ## Data Source Types |
There was a problem hiding this comment.
I'm not necessarily happy with the section title. I use it because that is what we call it within our app. Perhaps "Data Warehouses" would be a better title for this and perhaps also a better label for the field within the app?
There was a problem hiding this comment.
I don't have a strong opinion, but I'd like us to start adopting "Metric Source" and "Experiment Assignment Source" for those respective tables in our user's data warehouses. I'm not sure whether renaming this concept helps or hurts that, to be honest. I'd lean towards changing it to Data Warehouse, but I'd want to make sure we update this in as many places in the marketing + app itself.
Features and Changes
Reorganize Data Sources docs. This updates datasources page to be more in line with how we have people actually select their datasources in the UI. It adds a page for each data source and each event type. Some of the new pages are actually old ones moved from /guides. Others are copied from the old Connection Info section on the Data Sources page. The rest of the pages are just "docs coming soon" templates until we can fill them in with more info.
The main thing to review are:
The overall structure: The amount of nesting in the side panel is a bit much. The event-trackers and data warehouses currently don't have pages of their own but are just containers for organization. I was thinking of merging the two, but though making the distinction make things clearer and is worth the extra side menu depth. A possibility is to maybe create a new top level "Set Up" section, and make Data Warehouse and Event Trackers live under there - that would get rid of one level of hierarchy - the Data Source page which could continue to live under Platform.
The datasources.mdx file top two sections were rewritten borrowing from other sections below. The goal was to make it clearer and more inline with what the platform is actually showing. A thorough review of whether the language makes sense would be good.
Two new template files (they are very similar) are in the directories missing-datasource-docs.mdx and missing-event-tracker-docs.mdx. They language there might not fully resonate and I am open to alternate suggestions.
In the side menu I am calling the container "Data Warehouses" but on the datasources page and in our app we call it "Data Source Type".
Testing
Click around all links on the docs site, reading them, and seeing if they make sense.