ContainerSolutions/terraform-examples

add a `bin/check_docs.sh` script to enforce documentation conventions

Open

#183 opened on Sep 1, 2022

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)HCL (52 forks)github user discovery
CIdocumentationgood first issue

Repository metrics

Stars
 (162 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

  • Create check_docs.sh script
  • Automatically check documentation conventions in the script conventions
  • Add/Run the script on CI at every commit

Contributor guide

Research direction
Review the conventions linked in the issue, then create a shell script that checks each convention (e.g., file naming, headings) using tools like grep or bash, and add it to CI.
Tech stack
shell
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitshell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80