Skip to content

Fine-tuned instructions #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 8 commits into from
Feb 28, 2025
Merged

Fine-tuned instructions #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c1a2508
Added descriptions and faker samples
pdesmarets Feb 25, 2025
fe3c559
Merge remote-tracking branch 'upstream/main'
pdesmarets Feb 26, 2025
6cb78d2
Add model name
pdesmarets Feb 26, 2025
046cdb5
Added business names
pdesmarets Feb 28, 2025
56c66ac
Adjusted instructions to use Hackolade Studio
pdesmarets Feb 28, 2025
1759c88
Merge branch 'hackolade:main' into main
pdesmarets Feb 28, 2025
b95a46d
Adjusted business names
pdesmarets Feb 28, 2025
d76bb48
Fine-tuned instructions
pdesmarets Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,43 @@ This repository contains Hackolade data models that can be viewed on https://hub

The Hackolade Enterprise Model Hub is a metadata collaboration platform providing a unified and central access to your Hackolade Studio data models stored in one or more Git repositories. It empowers business teams, governance teams, and other stakeholders to collaborate effectively in order to promote a shared understanding of the context and meaning of data.

Feel free to explore at your leisure. It even allows you to [load your own models](#how-to-load-your-models-to-this-repository) into the repository, and view them in the Hub. We advise each organization to create its own folder, separate from others. The models and model changes you would push into the repository are auto-merged, then automatically replicated to the Hub database. They should appear in a few seconds.
Feel free to explore at your leisure. It even allows you to [load your own models](#how-to-load-your-models-to-this-repository) into the repository, and view them in the Hub. We advise each organization to create its own folder, separate from others. The models and model changes you push into the repository are auto-merged, then automatically replicated to the Hub database. They should appear in just a few seconds.

An online user documentation can be found [here](https://hackolade.com/help/Hubuserinterface.html).
The online user documentation for the Hub can be found [here](https://hackolade.com/help/Hubuserinterface.html).

**WARNING:** the Hackolade Model Hub is totally open to anyone, so we strongly suggest to refrain from loading any confidential models.
**WARNING:** this demo of Hackolade Model Hub is open to anyone, so you should refrain from loading any confidential models.

Hackolade reserves the right to remove any inappropriate content from this repository, or any content that would negatively affect the platform.

## How to load your models to this repository
This repository is configured with a "Fork & Pull" strategy, very common in open-source, and also in [inner-source](https://hackolade.com/help/Workingwithforks.html). But instead of having a maintainer review your models, we enabled an automatic merge of your models, so you could automatically see your models in the Hub a few seconds after having submitted your Pull Request (see step 4 below.)
You may explore the Hub with models already present in the repo. Loading your own models is optional, but the experience is more meaningful with your own models and terminology.

This repository is configured with a "Fork & Pull" strategy, very common in open-source, and also in [inner-source](https://hackolade.com/help/Workingwithforks.html). But instead of having a maintainer review your models, we enabled an automatic merge of your models, so you could quickly see your models in the Hub, soon after submitting your Pull Request (see step 4 below.)

Follow these steps in order to add models to this repository

1. **Fork the repository**

This step cannot be done in Hackolade Studio. It must be made in GitHub.
This step cannot be done in Hackolade Studio. It must be made in GitHub, and requires that you have a [GitHub account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github) (free.)

Click on this <a icon="repo-forked" class="github-button" href="https://github.com/hackolade/playground-models/fork">fork button</a> to copy this repository in your own GitHub account. This will open a form like the following
Click on this <a icon="repo-forked" class="github-button" href="https://github.com/hackolade/playground-models/fork">fork button</a> to copy the repository in your own GitHub account. This will open a form like the following

<img src="./docs/images/fork-form.png" />

You don't have to change anything, just click `Create fork`

1. Clone the new repository on your workstation by using your favorite Git tool or even better by using [Hackolade Studio](https://hackolade.com/help/Clonearemoterepository.html) to do so
1. Clone the new repository on your workstation with [Hackolade Studio](https://hackolade.com/help/Clonearemoterepository.html), or alternatively with you favorite Git client.
> Since this a is a public repository, make sure to not add any confidential models

> We advise each organization to create its own folder, separate from others

1. When you are done, [commit and push the model(s)](https://hackolade.com/help/Commitlocalchanges.html) on the forked repository.
1. Create new models or save existing models in the forked repo, then [commit and push the model(s)](https://hackolade.com/help/Commitlocalchanges.html).

1. In Hackolade Studio, [submit a Pull Request from the fork](https://hackolade.com/help/Workingwithforks.html#Submit%20a%20Pull%20Request%20from%20a%20fork).
1. Still in Hackolade Studio, [submit a Pull Request from the fork](https://hackolade.com/help/Workingwithforks.html#Submit%20a%20Pull%20Request%20from%20a%20fork).

1. After a few seconds, your pull request should be merged into the main repository, be replicated with the Hub database, and be visible on https://hub.hackolade.com
1. After a few seconds, your pull request should be merged into the main repository, replicated with the Hub database, then visible on https://hub.hackolade.com

As an alternative to step 4, you can manually do this on GitHub:
As an alternative to step 4, you can manually do this in GitHub screens:

4 alt. On the GitHub page, click on `Contribute` and `Open pull request` like shown on the picture below

Expand All @@ -47,4 +49,4 @@ As an alternative to step 4, you can manually do this on GitHub:

<img src="./docs/images/pull-request.png" />

6 alt. After a few seconds, your pull request should be merged into the main repository, be replicated with the Hub database, and be visible on https://hub.hackolade.com
6 alt. After a few seconds, your pull request should be merged into the main repository, replicated with the Hub database, then visible on https://hub.hackolade.com
38 changes: 22 additions & 16 deletions confluent/Confluent demo.hck.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@
}
},
{
"code": "orderlines",
"name": "orderLines",
"code": "OrderLines",
"name": "order Lines",
"isActivated": true,
"required": true,
"properties": [
Expand Down Expand Up @@ -123,9 +123,9 @@
}
},
{
"code": "product",
"code": "Product",
"GUID": "c4b72ef8-a56f-4aa2-baf4-3d54b74694ce",
"name": "product",
"name": "Product",
"type": "reference",
"$ref": "#/definitions/product",
"refType": "collectionReference",
Expand All @@ -134,7 +134,10 @@
"48e20d0f-104d-4ab3-a224-95150064e7dc"
],
"isActivated": true,
"error": {},
"error": {
"name": false,
"code": false
},
"refDescription": "This column represents the specific product being ordered. It could store a reference to the productID from the product table, or it could directly store the product name or SKU (Stock Keeping Unit), depending on the system’s design. The product column is used to identify which item is being purchased in each line of the order.",
"nullable": false,
"dependencies": [],
Expand Down Expand Up @@ -204,11 +207,14 @@
"uniqueItems": false,
"childType": "array",
"type": "array",
"error": {},
"GUID": "6830e97f-dca8-4600-a3e9-c525c2693c35",
"metaProps": [],
"hackoladeMeta": {
"namingConvention": "code"
},
"error": {
"name": false,
"code": false
}
}
],
Expand Down Expand Up @@ -572,15 +578,15 @@
"dataType": "",
"shape": [
{
"x": 1393,
"x": 1397,
"y": 1193
},
{
"x": 1463.5,
"x": 1465.5,
"y": 1193
},
{
"x": 1463.5,
"x": 1465.5,
"y": 1170.5
},
{
Expand Down Expand Up @@ -634,15 +640,15 @@
"dataType": "",
"shape": [
{
"x": 1393,
"x": 1397,
"y": 1306
},
{
"x": 1468.5,
"x": 1470.5,
"y": 1306
},
{
"x": 1468.5,
"x": 1470.5,
"y": 1318.5
},
{
Expand All @@ -664,7 +670,7 @@
"e2eb848c-cda5-47aa-8d53-e210eef7afbe": "order",
"f0a8dffb-4801-48e6-b38a-09429dcb411d": "Order ID",
"a32d7f72-588e-43dc-a034-8a85a6b0cbd2": "Order Date",
"6830e97f-dca8-4600-a3e9-c525c2693c35": "orderLines",
"6830e97f-dca8-4600-a3e9-c525c2693c35": "order Lines",
"6a474d94-c083-4c1a-811e-be8fa14a9f61": "customer",
"bb3df3b1-f9fa-4aab-8b1a-f7ed43bf5e4e": "Customer ID",
"85656d1d-be08-435a-8d4c-77b421d52e29": "First Name",
Expand All @@ -681,7 +687,7 @@
"14ca098f-1a6e-44ab-81e0-9d9bd27dae4c": "Identifier",
"1d650548-d6bc-44b9-a9cf-b670e776c362": "Unit Price",
"81f414a6-6ba3-431d-a926-f8e233d08297": "Quantity",
"c4b72ef8-a56f-4aa2-baf4-3d54b74694ce": "product",
"c4b72ef8-a56f-4aa2-baf4-3d54b74694ce": "Product",
"283c0014-b32c-44ee-bb8e-9f58da1827f1": "Line Num",
"71d70559-ef92-44c0-ac9e-7fbc6324286f": "Order Line"
},
Expand Down Expand Up @@ -749,7 +755,7 @@
},
"namingConvention": "code"
},
"lastModifTS": "2025-02-28T11:01:35.965Z",
"lastModifTS": "2025-02-28T13:10:02.910Z",
"persistenceSchemaVersion": "8",
"isCreatedByPlugin": true,
"pluginInformation": {
Expand All @@ -770,7 +776,7 @@
"GUID": "e2eb848c-cda5-47aa-8d53-e210eef7afbe",
"x": 1080,
"y": 1080,
"width": 313,
"width": 317,
"height": 339,
"color": {}
},
Expand Down