openedx / openedx/docs.openedx.org

Create docs view on Community Roadmap with CTAs

Open
#145 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs triage
Dominant language
JavaScript
Stars
35
Forks
95
Avg merge
5d 15h
Merged PRs (30d)
3

Description

The Open edX Community Roadmap should contain a course-level (epic/initiative level) view of the docs.openedx.org project. It should provide a bird's eye view of the strategic goals and milestones of the documentation overhaul, as well as provide community easy entrypoint to get involved. It should also link to the docs.openedx.org Project Board, which is meant to house fine-grained issues.

  • #174
  • Define standard approach for getting candidate authors the info they need - examples, templates
  • #146
  • #226

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 the Open edX Community Roadmap and the docs.openedx.org Project Board referenced in the issue. Define the course-level documentation view, strategic goals and milestones, candidate-author entry points, and links to the fine-grained project board; the work is done when that roadmap view and its CTAs are available to the community.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.