scanapi / scanapi/website

`Add to Project` Doc Page

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

Nobody has claimed this yet.

documentation hacktoberfest website website doc page
Dominant language
SCSS
Stars
10
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Add to Project Doc Page

A Documentation Page to teach how to add ScanAPI to a CI pipeline (i.e circleci).

More info at:
https://speakerdeck.com/cmaiacd/europython-2020-scanapi-automated-integration-testing-and-live-documentation-for-your-api?slide=27

The page should be under https://github.com/scanapi/website/tree/master/_docs_v1

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 in the _docs_v1 directory and review the linked presentation, especially slide 27, for the intended CI-pipeline workflow. Create the Add to Project documentation page there, covering how to add ScanAPI to a CI pipeline such as CircleCI; done means the page is complete and accessible with the surrounding documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.