-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Docs for release v.0.2.1 #88
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.
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
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| version: 1 | ||
| path: ./spec |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| ## daco describe | ||
|
|
||
| Show data product overview with ports and connections | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Show a summary of the data product including its metadata, | ||
| all defined ports, and all defined connections. | ||
|
|
||
| ``` | ||
| daco describe [flags] | ||
| ``` | ||
|
|
||
| ### Examples | ||
|
|
||
| ``` | ||
| # Describe the data product | ||
| daco describe | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for describe | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [daco](daco.md) - Data product CLI tool | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| ## daco product | ||
|
|
||
| Manage data product metadata | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Manage data product metadata defined in the OpenDPI spec. | ||
| Use subcommands to view or upgrade the product version. | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for product | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [daco](daco.md) - Data product CLI tool | ||
| * [daco product upgrade](daco_product_upgrade.md) - Upgrade the data product version | ||
| * [daco product version](daco_product_version.md) - Show the data product spec version | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| ## daco product upgrade | ||
|
|
||
| Upgrade the data product version | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Upgrade the data product version by bumping major, minor, or patch. | ||
| In interactive mode, a form is shown to select the bump type. | ||
|
|
||
| ``` | ||
| daco product upgrade [flags] | ||
| ``` | ||
|
|
||
| ### Examples | ||
|
|
||
| ``` | ||
| # Interactive mode | ||
| daco product upgrade | ||
|
|
||
| # Non-interactive | ||
| daco product upgrade --bump minor | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -b, --bump string Bump type: major, minor, or patch | ||
| -h, --help help for upgrade | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [daco product](daco_product.md) - Manage data product metadata | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| ## daco product version | ||
|
|
||
| Show the data product spec version | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Show the current version of the data product as defined in the OpenDPI spec. | ||
|
|
||
| ``` | ||
| daco product version [flags] | ||
| ``` | ||
|
|
||
| ### Examples | ||
|
|
||
| ``` | ||
| # Show the product version | ||
| daco product version | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for version | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [daco product](daco_product.md) - Manage data product metadata | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Myport | ||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-------|------|----------|-------------| | ||
| | `name` | string | Yes | | | ||
| | `metadata` | [Metadata](#Metadata) | Yes | | | ||
| | `spec` | [Spec](#Spec) | Yes | | | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Metadata | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-------|------|----------|-------------| | ||
| | `owner` | string | Yes | | | ||
| | `environment` | string | No | (enum: `prod`, `staging`, `dev`) | | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-------|------|----------|-------------| | ||
| | `name` | string | Yes | | | ||
| | `type` | string | Yes | (enum: `string`, `integer`, `boolean`, `float`) | | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Spec | ||
|
|
||
| | Field | Type | Required | Description | | ||
| |-------|------|----------|-------------| | ||
| | `fields` | array([Fields](#Fields)) | No | | | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| opendpi: 1.0.0 | ||
| info: | ||
| title: myproduct | ||
| version: 1.0.0 | ||
| connections: {} | ||
| ports: | ||
| myport: | ||
| connections: [] | ||
| schema: | ||
| $ref: schemas/myport.schema.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: "string" | ||
|
|
||
| # Nested Object: Metadata | ||
| metadata: | ||
| type: "object" | ||
| properties: | ||
| owner: | ||
| type: "string" | ||
| environment: | ||
| type: "string" | ||
| enum: ["prod", "staging", "dev"] | ||
| required: | ||
| - "owner" | ||
|
|
||
| # Nested Array of Objects: Columns/Fields | ||
| spec: | ||
| type: "object" | ||
| properties: | ||
| fields: | ||
| type: "array" | ||
| items: | ||
| type: "object" | ||
| properties: | ||
| name: | ||
| type: "string" | ||
| type: | ||
| type: "string" | ||
| enum: ["string", "integer", "boolean", "float"] | ||
| required: | ||
| - "name" | ||
| - "type" | ||
|
|
||
| required: | ||
| - "name" | ||
| - "metadata" | ||
| - "spec" |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: The "Fields" anchor is duplicated, so the Spec link points to the wrong section. Give the Fields type section a unique heading and update the link so readers land on the correct definition.
Prompt for AI agents