influxdata / influxdata/influxdb

Community Templates UI: Accept yml and github directory locations

Open
#19,454 0 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

area/templates team/ui
Dominant language
Rust
Stars
31.7k
Forks
3.7k
Avg merge
13h 37m
Merged PRs (30d)
8

Description

Background

When entering in a template, we would like to be able to enter either (1) the full url path to a yaml file (2) the package name of the github directory (e.g. for https://github.com/influxdata/community-templates/blob/master/kafka/kafka-template.yml we want to give them kafka).

Acceptance Criteria
  • the UI's url upload input accepts file paths and directories
    • it accepts arbitrary yaml / json / jsonnet files from the web
    • it accepts directories from our community templates github repo (e.g. kafka resolves to https://github.com/influxdata/community-templates/tree/master/kafka)
      • it looks for readme.md and manifest.(yml|yaml|json|jsonnet) files

WHEN I use template directory that does not exist in the community-templates repo
AND the templates schema directory doesn't match the required directory structure
THEN I should be informed that this template requires entering the URL directly

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.