-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
37 changed files
with
2,164 additions
and
59 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 @@ | ||
--- | ||
title: blackstork/atlassian | ||
weight: 20 | ||
plugin: | ||
name: blackstork/atlassian | ||
description: "The `atlassian` plugin for Atlassian Cloud." | ||
tags: [] | ||
version: "v0.4.2" | ||
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/atlassian/" | ||
type: docs | ||
hideInMenu: true | ||
--- | ||
|
||
{{< plugin-header "blackstork/atlassian" "atlassian" "v0.4.2" >}} | ||
|
||
## Description | ||
The `atlassian` plugin for Atlassian Cloud. | ||
|
||
## Installation | ||
|
||
To install the plugin, add it to `plugin_versions` map in the Fabric global configuration block (see [Global configuration]({{< ref "configs.md#global-configuration" >}}) for more details), with a version constraint restricting which available versions of the plugin the codebase is compatible with: | ||
|
||
```hcl | ||
fabric { | ||
plugin_versions = { | ||
"blackstork/atlassian" = ">= v0.4.2" | ||
} | ||
} | ||
``` | ||
|
||
|
||
## Data sources | ||
|
||
{{< plugin-resources "atlassian" "data-source" >}} |
This file contains 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,114 @@ | ||
--- | ||
title: "`jira_issues` data source" | ||
plugin: | ||
name: blackstork/atlassian | ||
description: "Retrieve issues from Jira" | ||
tags: [] | ||
version: "v0.4.2" | ||
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/atlassian/" | ||
resource: | ||
type: data-source | ||
type: docs | ||
--- | ||
|
||
{{< breadcrumbs 2 >}} | ||
|
||
{{< plugin-resource-header "blackstork/atlassian" "atlassian" "v0.4.2" "jira_issues" "data source" >}} | ||
|
||
## Description | ||
Retrieve issues from Jira. | ||
|
||
## Installation | ||
|
||
To use `jira_issues` data source, you must install the plugin `blackstork/atlassian`. | ||
|
||
To install the plugin, add the full plugin name to the `plugin_versions` map in the Fabric global configuration block (see [Global configuration]({{< ref "configs.md#global-configuration" >}}) for more details), as shown below: | ||
|
||
```hcl | ||
fabric { | ||
plugin_versions = { | ||
"blackstork/atlassian" = ">= v0.4.2" | ||
} | ||
} | ||
``` | ||
|
||
Note the version constraint set for the plugin. | ||
|
||
## Configuration | ||
|
||
The data source supports the following configuration arguments: | ||
|
||
```hcl | ||
config data jira_issues { | ||
# Account Domain. | ||
# | ||
# Required string. | ||
# Must be non-empty | ||
# For example: | ||
domain = "some string" | ||
# Account Email. | ||
# | ||
# Required string. | ||
# Must be non-empty | ||
# For example: | ||
account_email = "some string" | ||
# API Token. | ||
# | ||
# Required string. | ||
# Must be non-empty | ||
# For example: | ||
api_token = "some string" | ||
} | ||
``` | ||
|
||
## Usage | ||
|
||
The data source supports the following execution arguments: | ||
|
||
```hcl | ||
data jira_issues { | ||
# Use expand to include additional information about issues in the response. | ||
# | ||
# Optional string. | ||
# Must be one of: "renderedFields", "names", "schema", "changelog" | ||
# For example: | ||
# expand = "names" | ||
# | ||
# Default value: | ||
expand = null | ||
# A list of fields to return for each issue. | ||
# | ||
# Optional list of string. | ||
# For example: | ||
# fields = ["*all"] | ||
# | ||
# Default value: | ||
fields = null | ||
# A JQL expression. For performance reasons, this field requires a bounded query. A bounded query is a query with a search restriction. | ||
# | ||
# Optional string. | ||
# For example: | ||
# jql = "order by key desc" | ||
# | ||
# Default value: | ||
jql = null | ||
# A list of up to 5 issue properties to include in the results. | ||
# | ||
# Optional list of string. | ||
# Must have a length of at most 5 | ||
# Default value: | ||
properties = [] | ||
# Size limit to retrieve. | ||
# | ||
# Optional number. | ||
# Must be >= 0 | ||
# Default value: | ||
size = 0 | ||
} | ||
``` |
This file contains 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,69 @@ | ||
--- | ||
title: "`hub` publisher" | ||
plugin: | ||
name: blackstork/builtin | ||
description: "Publish documents to Blackstork Hub." | ||
tags: [] | ||
version: "v0.4.2" | ||
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/builtin/" | ||
resource: | ||
type: publisher | ||
type: docs | ||
--- | ||
|
||
{{< breadcrumbs 2 >}} | ||
|
||
{{< plugin-resource-header "blackstork/builtin" "builtin" "v0.4.2" "hub" "publisher" >}} | ||
|
||
The publisher is built-in, which means it's a part of `fabric` binary. It's available out-of-the-box, no installation required. | ||
|
||
#### Formats | ||
|
||
The publisher supports the following document formats: | ||
|
||
- `unknown` | ||
|
||
To set the output format, specify it inside `publish` block with `format` argument. | ||
|
||
|
||
#### Configuration | ||
|
||
The publisher supports the following configuration arguments: | ||
|
||
```hcl | ||
config publish hub { | ||
# API url. | ||
# | ||
# Required string. | ||
# Must be non-empty | ||
# For example: | ||
api_url = "some string" | ||
# API url. | ||
# | ||
# Required string. | ||
# Must be non-empty | ||
# For example: | ||
api_token = "some string" | ||
} | ||
``` | ||
|
||
#### Usage | ||
|
||
The publisher supports the following execution arguments: | ||
|
||
```hcl | ||
# In addition to the arguments listed, `publish` block accepts `format` argument. | ||
publish hub { | ||
# Hub Document title override. By default uses title configured in the document. | ||
# | ||
# Optional string. | ||
# Must be non-empty | ||
# Default value: | ||
title = null | ||
} | ||
``` | ||
|
This file contains 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 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 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,28 @@ | ||
fabric { | ||
plugin_versions = { | ||
"blackstork/atlassian" = ">= 0.5 < 1.0 || 0.5.0-rev0" | ||
} | ||
} | ||
|
||
config data jira_issues { | ||
domain = env.JIRA_DOMAIN | ||
account_email = env.JIRA_ACCOUNT_EMAIL | ||
api_token = env.JIRA_API_TOKEN | ||
} | ||
|
||
document "example" { | ||
title = "Using atlassian plugin" | ||
data jira_issues "my_issues" { | ||
expand = "names" | ||
fields = ["*all"] | ||
jql = "project = TEST" | ||
size = 5 | ||
} | ||
content title { | ||
value = "My Jira Issues" | ||
} | ||
content list { | ||
item_template = "{{.key}}: {{.fields.summary}}" | ||
items = query_jq(".data.jira_issues.my_issues") | ||
} | ||
} |
Oops, something went wrong.