scanapi / scanapi/website

Add Global Variables Example to Tutorial

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

Nobody has claimed this yet.

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

Description

Description:

The tutorial currently does not cover how to use Global Variables in ScanAPI. Including this will make it easier for new users to understand and apply the feature in real scenarios.

This issue aims to:

  • Update the tutorial with a clear example using Global Variables.
  • Show how they can simplify configurations and reduce duplication.
  • Highlight best practices for combining global and local variables.

Depends on: https://github.com/scanapi/demo-api/issues/98
Reference: Implemented in #265

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

Review the tutorial content and the referenced implementation in issue #265 first, then check the dependency in demo-api issue #98. Add a Global Variables example covering configuration reuse and the interaction between global and local variables; done means the tutorial explains these points clearly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.