Documentation is an essential component of building a sustainable data architecture, but is sometimes put aside to focus on development work to meet deadlines. Coalesce automatically produces and updates documentation as developers work, thereby freeing them to work on higher-value deliverables.
Generated documentation for a Workspace/Environment can be accessed in three different ways.
- Both Workspaces and Environments - From the top of the user interface, via the Docs link
- Only Workspaces - From the Projects Dashboard, via the Docs icon
- Only Environments - From the Deploy Dashboard, via the ellipsis → View Docs
The new documentation interface consists of 3 sections highlighted in the following image:
The Filters dropdowns allow the user to limit the nodes currently visible in the Results List. For example, if one wanted to see only nodes of type Stage, then they would select Node type → Stage, and the Results List will be updated in real time.
Users can search for node names, physical types, databases, schemas, and storage locations. Node names can be searched for using any portion of the node's name, while all other objects are searched using a prefix search only. For example - if the storage location is
PROD_RAW, searching for
RAW will not yield any results. On the other hand, if a node is named
STG_CUSTOMER, searching for either
CUST will be effective.
Searching for Columns
Individual columns are not currently searchable but this is a planned feature on the Coalesce roadmap.
This section will have the results, which come from a combination of search terms and filters used.
Search terms and filters automatically adjust/expand the URL, which makes results easy to share, as other users can use the same URL to access the same results.
Updated about 2 months ago