openedx / openedx/docs.openedx.org

Put overall maintenance checker results in README, on a cron

Open
#1,010 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

build-issue
Dominant language
JavaScript
Stars
35
Forks
95
Avg merge
5d 15h
Merged PRs (30d)
3

Description

  • Run the maintenance_chart_checker (#1008 ) and put the results in the README, under the Submit Documentation Issues header
  • Put the script on a biweekly cron job that:
    • Runs the script
    • Opens a PR to put the output into the README

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 with maintenance_chart_checker issue #1008 and the README's Submit Documentation Issues section. Determine how the checker is run, then configure a biweekly cron job to update the README and open a pull request; done means the results appear in that section and the scheduled workflow produces the PR.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.