mirror of
https://github.com/datahub-project/datahub.git
synced 2025-06-27 05:03:31 +00:00
docs: Format stragglers via prettier (#13247)
This commit is contained in:
Andrew Sikowitz
GitHub
parent
23ceff950b
commit
e9a7d35cb8
@ -14,9 +14,9 @@ Feel free to take a look around, deploy, and contribute.
|
||||
|
||||
The initial milestone for the app was to achieve functional parity with the previous Ember app. This meant supporting
|
||||
|
||||
- Dataset Profiles, Search, Browse Experience
|
||||
- User Profiles, Search
|
||||
- LDAP Authentication Flow
|
||||
- Dataset Profiles, Search, Browse Experience
|
||||
- User Profiles, Search
|
||||
- LDAP Authentication Flow
|
||||
|
||||
This has since been achieved. The new set of functional goals are reflected in the latest version of the [DataHub Roadmap](../docs/roadmap.md).
|
||||
|
||||
@ -58,8 +58,8 @@ Optionally you could also start the app with the mock server without running the
|
||||
|
||||
There is two options to test your customizations:
|
||||
|
||||
- **Option 1**: Initialize the docker containers with the `quickstart.sh` script (or if any custom docker-compose file) and then run `yarn start` in this directory. This will start a forwarding server at `localhost:3000` that will use the `datahub-frontend` server at `http://localhost:9002` to fetch real data.
|
||||
- **Option 2**: Change the environment variable `REACT_APP_PROXY_TARGET` in the `.env` file to point to your `datahub-frontend` server (ex: https://my_datahub_host.com) and then run `yarn start` in this directory. This will start a forwarding server at `localhost:3000` that will use the `datahub-frontend` server at some domain to fetch real data.
|
||||
- **Option 1**: Initialize the docker containers with the `quickstart.sh` script (or if any custom docker-compose file) and then run `yarn start` in this directory. This will start a forwarding server at `localhost:3000` that will use the `datahub-frontend` server at `http://localhost:9002` to fetch real data.
|
||||
- **Option 2**: Change the environment variable `REACT_APP_PROXY_TARGET` in the `.env` file to point to your `datahub-frontend` server (ex: https://my_datahub_host.com) and then run `yarn start` in this directory. This will start a forwarding server at `localhost:3000` that will use the `datahub-frontend` server at some domain to fetch real data.
|
||||
|
||||
The option 2 is useful if you want to test your React customizations without having to run the hole DataHub stack locally. However, if you changed other components of the DataHub stack, you will need to run the hole stack locally (building the docker images) and use the option 1.
|
||||
|
||||
@ -118,25 +118,25 @@ for functional configurability should reside.
|
||||
|
||||
**app** - Contains all important components of the app. It has a few sub-modules:
|
||||
|
||||
- `auth`: Components used to render the user authentication experience.
|
||||
- `browse`: Shared components used to render the 'browse-by-path' experience. The experience is akin to navigating a filesystem hierarchy.
|
||||
- `preview`: Shared components used to render Entity 'preview' views. These can appear in search results, browse results,
|
||||
and within entity profile pages.
|
||||
- `search`: Shared components used to render the full-text search experience.
|
||||
- `shared`: Misc. shared components
|
||||
- `entity`: Contains Entity definitions, where entity-specific functionality resides.
|
||||
Configuration is provided by implementing the 'Entity' interface. (See DatasetEntity.tsx for example)
|
||||
There are 2 visual components each entity should supply:
|
||||
- `auth`: Components used to render the user authentication experience.
|
||||
- `browse`: Shared components used to render the 'browse-by-path' experience. The experience is akin to navigating a filesystem hierarchy.
|
||||
- `preview`: Shared components used to render Entity 'preview' views. These can appear in search results, browse results,
|
||||
and within entity profile pages.
|
||||
- `search`: Shared components used to render the full-text search experience.
|
||||
- `shared`: Misc. shared components
|
||||
- `entity`: Contains Entity definitions, where entity-specific functionality resides.
|
||||
Configuration is provided by implementing the 'Entity' interface. (See DatasetEntity.tsx for example)
|
||||
There are 2 visual components each entity should supply:
|
||||
|
||||
- `profiles`: display relevant details about an individual entity. This serves as the entity's 'profile'.
|
||||
- `previews`: provide a 'preview', or a smaller details card, containing the most important information about an entity instance.
|
||||
- `profiles`: display relevant details about an individual entity. This serves as the entity's 'profile'.
|
||||
- `previews`: provide a 'preview', or a smaller details card, containing the most important information about an entity instance.
|
||||
|
||||
When rendering a preview, the entity's data and the type of preview (SEARCH, BROWSE, PREVIEW) are provided. This
|
||||
allows you to optionally customize the way an entities preview is rendered in different views.
|
||||
|
||||
- `entity registry`: There's another very important piece of code living within this module: the **EntityRegistry**. This is a layer
|
||||
of abstraction over the intimate details of rendering a particular entity. It is used
|
||||
to render a view associated with a particular entity type (user, dataset, etc.).
|
||||
- `entity registry`: There's another very important piece of code living within this module: the **EntityRegistry**. This is a layer
|
||||
of abstraction over the intimate details of rendering a particular entity. It is used
|
||||
to render a view associated with a particular entity type (user, dataset, etc.).
|
||||
|
||||
<p align="center">
|
||||
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/entity-registry.png"/>
|
||||
|
||||
@ -178,7 +178,9 @@ These privileges are for DataHub operators to access & manage the administrative
|
||||
| Manage Monitors[^2] | Allow actor to create, update, and delete any data asset monitors, including Custom SQL monitors. Grant with care. |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
[^3]: Deprecated feature
|
||||
|
||||
#### Entity Management
|
||||
@ -205,6 +207,7 @@ These privileges are for DataHub operators to access & manage the administrative
|
||||
| Manage System Operations | Allow actor to manage system operation controls. This setting includes all System Management privileges. |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
### Common Metadata Privileges
|
||||
@ -227,6 +230,7 @@ These privileges are to view & modify any entity within DataHub.
|
||||
| Share Entity[^2] | Allow actor to share an entity with another DataHub Cloud instance. |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
#### Aspect Privileges
|
||||
@ -248,6 +252,7 @@ These privileges are to view & modify any entity within DataHub.
|
||||
| Get Timeseries Aspect API[^1] | Allow actor to use the GET Timeseries Aspect API. |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
#### Proposals
|
||||
@ -262,6 +267,7 @@ These privileges are to view & modify any entity within DataHub.
|
||||
| Manage Documentation Proposals[^2] | Allow actor to manage a proposal update an asset's documentation |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
### Specific Entity-level Privileges
|
||||
@ -280,6 +286,7 @@ These privileges are not generalizable.
|
||||
| User | Edit User Profile | Allow actor to change the user's profile including display name, bio, title, profile image, etc. |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
#### Dataset
|
||||
@ -309,6 +316,7 @@ These privileges are not generalizable.
|
||||
| GlossaryNode | Manage All Glossary Children | Allow actor to create and delete everything underneath this entity. |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
#### Misc
|
||||
@ -321,6 +329,7 @@ These privileges are not generalizable.
|
||||
| GlossaryNode | Manage All Glossary Children | Allow actor to create and delete everything underneath this entity. |
|
||||
|
||||
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
|
||||
|
||||
[^2]: DataHub Cloud only
|
||||
|
||||
## Coming Soon
|
||||
|
||||
@ -5,6 +5,7 @@ title: Form Analytics
|
||||
import FeatureAvailability from '@site/src/components/FeatureAvailability';
|
||||
|
||||
# DataHub Compliance Form Analytics
|
||||
|
||||
<FeatureAvailability saasOnly />
|
||||
|
||||
DataHub Cloud provides out-of-the-box analytics to help you monitor and track the success of your Compliance Form initiatives. This guide will walk you through the available reporting views and how to leverage them effectively.
|
||||
@ -23,6 +24,7 @@ Form Analytics provides out-of-the-box reporting for Compliance Form completion,
|
||||
4. Assignee Performance Tracking
|
||||
|
||||
Each reporting view can be filtered by Assigned Date with the following preset ranges:
|
||||
|
||||
- Last 7 days
|
||||
- Last 30 days
|
||||
- Last 90 days
|
||||
@ -64,6 +66,7 @@ Assets can have multiple Forms assigned simultaneously. An Asset's overall statu
|
||||
The Overall view provides a high-level summary of Form completion across your organization, helping you quickly identify which Forms, Domains, or Assignees need attention. Use this view as your starting point to determine which drill-down view (Form-specific, Domain-based, or Assignee) will be most helpful for addressing completion gaps.
|
||||
|
||||
Key features:
|
||||
|
||||
- Aggregated view of all assets and their Form status
|
||||
- Total number of assets in each state
|
||||
- High-level compliance progress metrics
|
||||
@ -79,6 +82,7 @@ Key features:
|
||||
### Form-Specific Analysis
|
||||
|
||||
The Form-specific view allows you to drill down into individual Forms to understand their completion status. This view is particularly useful for:
|
||||
|
||||
- Tracking progress of specific compliance initiatives
|
||||
- Identifying questions that users might be slow to address
|
||||
- Generating form-specific reports
|
||||
@ -94,6 +98,7 @@ The Form-specific view allows you to drill down into individual Forms to underst
|
||||
### Domain-Based Insights
|
||||
|
||||
The Domain view provides visibility into Form completion rates across different business domains. This perspective helps:
|
||||
|
||||
- Domain managers focus on their area of responsibility
|
||||
- Compare progress across different domains
|
||||
- Identify if specific Forms within a domain need attention
|
||||
@ -109,6 +114,7 @@ The Domain view provides visibility into Form completion rates across different
|
||||
### Assignee Performance Tracking
|
||||
|
||||
The Assignee view allows you to monitor how specific Users or User Groups are tracking toward their assigned tasks. Use this view to:
|
||||
|
||||
- Track individual user's compliance tasks
|
||||
- Monitor workload distribution
|
||||
- Identify potential bottlenecks
|
||||
@ -135,4 +141,4 @@ To make the most of Form Analytics:
|
||||
### Related Features
|
||||
|
||||
- [Create a Compliance Form](create-a-form.md)
|
||||
- [Complete a Compliance Form](complete-a-form.md)
|
||||
- [Complete a Compliance Form](complete-a-form.md)
|
||||
|
||||
@ -5,7 +5,6 @@ If you're using an earlier version, ingestion of **Experiments** and **Runs** wi
|
||||
|
||||
:::
|
||||
|
||||
|
||||
### Concept Mapping
|
||||
|
||||
This ingestion source maps the following MLflow Concepts to DataHub Concepts:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user