opendevstack / opendevstack/ods-documentation

General update procedure cannot always be completed before version-specific procedure

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

Nobody has claimed this yet.

Dominant language
CSS
Stars
0
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Sometimes one needs to do a change from the "version specific procedure" before / during the general steps.

We should probably move to one complete guide per version, listing all necessary steps in the right order.

FYI @gerardcl

Contributor guide

No contributing guide indexed for this repository

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 by inspecting the Antora playbooks in this repository, locating the general update procedure and the version-specific procedures. Determine how the current guides are organized and which steps must be ordered together. Done means each supported version has one complete guide containing all necessary steps in the correct order.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.