Skip to content

Commit

Permalink
fix: fix it to run link check in yarnlint
Browse files Browse the repository at this point in the history
  • Loading branch information
yoonhyejin committed Sep 8, 2023
1 parent d01dd19 commit bdd6892
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 10 deletions.
38 changes: 38 additions & 0 deletions docs-website/markdown-link-check-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"ignorePatterns": [
{
"pattern": "^http://demo\\.datahubproject\\.io"
},
{
"pattern": "^http://localhost"
},
{
"pattern": "^http://www.famfamfam.com"
},
{
"pattern": "^http://www.linkedin.com"
},
{
"pattern": "\\.md$"
},
{
"pattern": "\\.pdl$"
},
{
"pattern":"\\.json$"
},
{
"pattern":"\\.txt$"
},
{
"pattern":"\\.js$"
},
{
"pattern": "\\.svg$"
},
{
"pattern": "\\.md#.*$"
}
],
"aliveStatusCodes": [200, 206, 0, 999, 400, 401, 403]
}
2 changes: 1 addition & 1 deletion docs-website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"generate": "rm -rf genDocs genStatic && mkdir genDocs genStatic && yarn _generate-docs && mv docs/* genDocs/ && rmdir docs",
"generate-rsync": "mkdir -p genDocs genStatic && yarn _generate-docs && rsync -v --checksum -r -h -i --delete docs/ genDocs && rm -rf docs",
"lint": "prettier -w generateDocsDir.ts sidebars.js src/pages/index.js",
"lint-check": "prettier -l generateDocsDir.ts sidebars.js src/pages/index.js && git diff --name-only --cached | grep 'docs/' | xargs -I % markdown-link-check -q -p %",
"lint-check": "prettier -l generateDocsDir.ts sidebars.js src/pages/index.js && find ../docs -name '*.md' -exec markdown-link-check -q {} -c markdown-link-check-config.json \\;",
"lint-fix": "prettier --write generateDocsDir.ts sidebars.js src/pages/index.js"
},
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion docs/api/graphql/how-to-set-up-graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ In the request body, select the `GraphQL` option and enter your GraphQL query in
</p>


Please refer to [Querying with GraphQL](https://learning.postman.com/docs/sending-requests/graphql/graphql/) in the Postman documentation for more information.
Please refer to [Querying with GraphQL](https://learning.postman.com/docs/sending-requests/graphql/graphql-overview/) in the Postman documentation for more information.

### Authentication + Authorization

Expand Down
2 changes: 1 addition & 1 deletion docs/docker/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The screenshot shows an example configuration for IntelliJ using the default GMS


<p align="center">
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/development/intellij-remote-dgfgfgfebug.png"/>
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/development/intellij-remote-debug.png"/>
</p>


Expand Down
8 changes: 4 additions & 4 deletions docs/modeling/extending-the-metadata-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We will refer to the two options as the **open-source fork** and **custom reposi
## This Guide

This guide will outline what the experience of adding a new Entity should look like through a real example of adding the
Dashboard Entity. If you want to extend an existing Entity, you can skip directly to [Step 3](#step_3).
Dashboard Entity. If you want to extend an existing Entity, you can skip directly to [Step 3](#step-3-define-custom-aspects-or-attach-existing-aspects-to-your-entity).

At a high level, an entity is made up of:

Expand Down Expand Up @@ -89,7 +89,7 @@ the annotation model.

### <a name="step_2"></a>Step 2: Create the new entity with its key aspect

Define the entity within an `entity-registry.yml` file. Depending on your approach, the location of this file may vary. More on that in steps [4](#step_4) and [5](#step_5).
Define the entity within an `entity-registry.yml` file. Depending on your approach, the location of this file may vary. More on that in steps [4](#step-4-choose-a-place-to-store-your-model-extension) and [5](#step_5).

Example:
```yaml
Expand Down Expand Up @@ -212,11 +212,11 @@ After you create your Aspect, you need to attach to all the entities that it app

**Constraints**: Note that all aspects MUST be of type Record.

### <a name="step_4"></a> Step 4: Choose a place to store your model extension
### <a name="step_4"></a>Step 4: Choose a place to store your model extension

At the beginning of this document, we walked you through a flow-chart that should help you decide whether you need to maintain a fork of the open source DataHub repo for your model extensions, or whether you can just use a model extension repository that can stay independent of the DataHub repo. Depending on what path you took, the place you store your aspect model files (the .pdl files) and the entity-registry files (the yaml file called `entity-registry.yaml` or `entity-registry.yml`) will vary.

- Open source Fork: Aspect files go under [`metadata-models`](../../metadata-models) module in the main repo, entity registry goes into [`metadata-models/src/main/resources/entity-registry.yml`](../../metadata-models/src/main/resources/entity-registry.yml). Read on for more details in [Step 5](#step_5).
- Open source Fork: Aspect files go under [`metadata-models`](../../metadata-models) module in the main repo, entity registry goes into [`metadata-models/src/main/resources/entity-registry.yml`](../../metadata-models/src/main/resources/entity-registry.yml). Read on for more details in [Step 5](#step-5-attaching-your-non-key-aspects-to-the-entity).
- Custom repository: Read the [metadata-models-custom](../../metadata-models-custom/README.md) documentation to learn how to store and version your aspect models and registry.

### <a name="step_5"></a>Step 5: Attaching your non-key Aspect(s) to the Entity
Expand Down
2 changes: 1 addition & 1 deletion docs/modeling/metadata-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ aggregation query against a timeseries aspect.
The *@TimeseriesField* and the *@TimeseriesFieldCollection* are two new annotations that can be attached to a field of
a *Timeseries aspect* that allows it to be part of an aggregatable query. The kinds of aggregations allowed on these
annotated fields depends on the type of the field, as well as the kind of aggregation, as
described [here](#Performing-an-aggregation-on-a-Timeseries-aspect).
described [here](#Performing-an-aggregation-on-a-Timeseries-aspect.).

* `@TimeseriesField = {}` - this annotation can be used with any type of non-collection type field of the aspect such as
primitive types and records (see the fields *stat*, *strStat* and *strArray* fields
Expand Down
2 changes: 1 addition & 1 deletion docs/townhall-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ November Town Hall (in December!)

* Welcome - 5 mins
* Latest React App Demo! ([video](https://www.youtube.com/watch?v=RQBEJhcen5E)) by John Joyce and Gabe Lyons - 5 mins
* Use-Case: DataHub at Geotab ([slides](https://docs.google.com/presentation/d/1qcgO3BW5NauuG0HnPqrxGcujsK-rJ1-EuU-7cbexkqE/edit?usp=sharing),[video](https://www.youtube.com/watch?v=boyjT2OrlU4)) by [John Yoon](https://www.linkedin.com/in/yhjyoon/) - 15 mins
* Use-Case: DataHub at Geotab ([video](https://www.youtube.com/watch?v=boyjT2OrlU4)) by [John Yoon](https://www.linkedin.com/in/yhjyoon/) - 15 mins
* Tech Deep Dive: Tour of new pull-based Python Ingestion scripts ([slides](https://docs.google.com/presentation/d/15Xay596WDIhzkc5c8DEv6M-Bv1N4hP8quup1tkws6ms/edit#slide=id.gb478361595_0_10),[video](https://www.youtube.com/watch?v=u0IUQvG-_xI)) by [Harshal Sheth](https://www.linkedin.com/in/hsheth2/) - 15 mins
* General Q&A from sign up sheet, slack, and participants - 15 mins
* Closing remarks - 5 mins
Expand Down
2 changes: 1 addition & 1 deletion docs/what/mxe.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ A Metadata Change Event represents a request to change multiple aspects for the
It leverages a deprecated concept of `Snapshot`, which is a strongly-typed list of aspects for the same
entity.

A MCE is a "proposal" for a set of metadata changes, as opposed to [MAE](#metadata-audit-event), which is conveying a committed change.
A MCE is a "proposal" for a set of metadata changes, as opposed to [MAE](#metadata-audit-event-mae), which is conveying a committed change.
Consequently, only successfully accepted and processed MCEs will lead to the emission of a corresponding MAE / MCLs.

### Emission
Expand Down

0 comments on commit bdd6892

Please sign in to comment.