Contribution of Synthetic Data Use Cases, Requirements & Language and Terminology from #30

finos / datahub

DataHub - Synthetic data library

https://datahub.finos.org

Apache License 2.0

80 stars 13 forks source link

Contribution of Synthetic Data Use Cases, Requirements & Language and Terminology from #30 #39

Closed mcleo-d closed 3 years ago

mcleo-d commented 3 years ago

Description

This PR combines and reformats the User Cases, Requirements and Language and Terminology contributions as markdown made by @andrewcarrblue and @BenFielding in the comments of #30

Contributed Folder Structure

|__ docs
    |__ synthetic-data-roadmap
        |__ language-and-terminology.md
        |__ use-cases-and-requirements.md

Additional Information

This PR does not close #30 as there are addition tasks mapped out in the issue for taking prioritised stories into development.

mcleo-d commented 3 years ago

Hi @maoo,

A build status update is expected from https://github.com/finos/datahub/blob/master/.github/workflows/build.yml to allow this PR to be merged.

This is as highlighted in the build status datahub-build Expected — Waiting for status to be reported which is stemming from the GitHub Action error being throw below from .github/workflows/docusaurus.yml ...

https://github.com/finos/datahub/actions/runs/193276436

Check failure on line 1 in .github

@github-actions github-actions / website-build

.github#L1
Resource not accessible by integration

Is there a new or updated version of https://github.com/finos/datahub/blob/master/.github/workflows/docusaurus.yml that should be added to the project?

Many thanks 🚀 🚀 🚀

James.

maoo commented 3 years ago

I may have a clue on what is going on.

The datahub-build action is required in order to merge the PR, however, the action only gets triggered if some specific files are updated, see https://github.com/finos/datahub/blob/master/.github/workflows/build.yml#L11-L29

I'd suggest - at least for testing - to either:

Remove the mandatory requirement of datahub-build from PRs, OR
Run the build for any change, regardless where that is; note that this will waste some build cycles, since there's no value building datahub when - for example - the README.md is updated

Please let me know if you have any questions.

mcleo-d commented 3 years ago

Hi @grovesy,

@maoo has left feedback on DataHub that could help solve the build blocker we are observing - https://github.com/finos/datahub/pull/39#issuecomment-692026619

I may have a clue on what is going on.

The datahub-build action is required in order to merge the PR, however, the action only gets triggered if some specific files are updated, see https://github.com/finos/datahub/blob/master/.github/workflows/build.yml#L11-L29

I'd suggest - at least for testing - to either:

Remove the mandatory requirement of datahub-build from PRs, OR

Run the build for any change, regardless where that is; note that this will waste some build cycles, since there's no value building datahub when - for example - the README.md is updated

Please let me know if you have any questions.

Are you able to commit the change to the build given you understand how DataHub is built and the expectations of the script?

Many thanks,

James.