Update new integration template #17474
Conversation
Updating to include more info/examples
…ation/check/{check_name}/CHANGELOG.md
Co-authored-by: Erica Ho <109224841+eho1307@users.noreply.github.com>
…ation/check/{check_name}/README.md
Co-authored-by: Erica Ho <109224841+eho1307@users.noreply.github.com>
…ation/check/{check_name}/manifest.json
Co-authored-by: Erica Ho <109224841+eho1307@users.noreply.github.com>
…ation/check/{check_name}/manifest.json
Co-authored-by: Erica Ho <109224841+eho1307@users.noreply.github.com>
…ation/check/{check_name}/manifest.json
Co-authored-by: Erica Ho <109224841+eho1307@users.noreply.github.com>
…ation/check/{check_name}/manifest.json
…ation/check/{check_name}/manifest.json
…ation/marketplace/IMAGES_README.md Co-authored-by: Erica Ho <109224841+eho1307@users.noreply.github.com>
…ation/tile/{check_name}/manifest.json
…ation/tile/{check_name}/manifest.json
…ation/marketplace/README.md
…ation/tile/{check_name}/README.md
…ation/tile/{check_name}/manifest.json
…ation/tile/{check_name}/manifest.json
…ation/check/{check_name}/manifest.json
- display on public website - media
iliakur
changed the title
Test Results 4 files 4 suites 3m 39s ⏱️ For more details on these failures, see this check. Results for commit e8ae1f2. |
| "title": "{integration_name}", | ||
| "media": [], | ||
| "media": {media}, |
There was a problem hiding this comment.
Does this mean it will link to the outline that's included in the assets/dashboard manifest? ex:
"media": [
{
"media_type": "image",
"caption": "FILL IN Image 1 caption",
"image_url": ""
},
{
"media_type": "image",
"caption": "FILL IN Image 2 caption",
"image_url": ""
},
{
"media_type": "image",
"caption": "FILL IN Image 3 caption",
"image_url": ""
}
| "tile": {{ | ||
| "overview": "README.md#Overview", | ||
| "configuration": "README.md#Setup", | ||
| "support": "README.md#Support", | ||
| "changelog": "CHANGELOG.md", | ||
| "description": "", | ||
| "description": "<FILL IN>", |
There was a problem hiding this comment.
can we replace with: "<FILL IN - A brief description of what this offering provides>"
| "tile": {{ | ||
| "overview": "README.md#Overview", | ||
| "configuration": "README.md#Setup", | ||
| "support": "README.md#Support", | ||
| "changelog": "CHANGELOG.md", | ||
| "description": "", | ||
| "description": "<FILL IN>", |
There was a problem hiding this comment.
can we replace with: "<FILL IN - A brief description of what this offering provides>"
| ] | ||
| }}, | ||
| "assets": {{ | ||
| "dashboards": {{}}, | ||
| "dashboards": {{ | ||
| "<FILL IN dashboard short_name>": "assets/dashboards/<FILL IN>.json" |
There was a problem hiding this comment.
| "<FILL IN dashboard short_name>": "assets/dashboards/<FILL IN>.json" | |
| "<FILL IN dashboard short_name ex: integration name overview>": "assets/dashboards/<FILL IN>.json" |
What does this PR do?
Updates template for creating a new integration.
Motivation
Incorporating feedback from partners while staying compatible with integrations-core practices.
Meant to supercede #17317
Additional Notes
Review checklist (to be filled by reviewers)
qa/skip-qalabel if the PR doesn't need to be tested during QA.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged