scanapi / scanapi/website

Templates Marketplace

Open
#10 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement website
Dominant language
SCSS
Stars
10
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Description

Page to aggregate all custom report templates (.jinja) created by community. There, people would be able to download and use templates created by other users.

Something like danger's plugins section: https://danger.systems/ruby/

image

We could have a new repo to store all templates and only link them in the website.

Maybe we should define a structure that requires at least 3 things to consider it as valid template (thus a valid PR):

  1. The Jinja template itself
  2. A metadata file (yml/json containing name, description, author, tags, etc for the outstanding template)
  3. A thumbnail in a specific format and size that could be displayed as showcase

We could also use Danger to validate these things BTW.

If all templates in this repo have these minimum requirements, in the future we could also have a tool to display and search for them in the website.

https://github.com/scanapi/scanapi/issues/184
https://github.com/scanapi/scanapi/issues/176#issuecomment-643673088

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.

Research direction

Start by reviewing the website structure and the linked ScanAPI issues for the intended marketplace scope. Define whether templates live in a new repository or the website, then specify the required Jinja template, metadata file, and thumbnail structure. Consider how Danger validation and future website display or search would fit the proposal.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll, ruby
Domain
content, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.