osbuild / osbuild/osbuild.github.io

Manpages are missing

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

Nobody has claimed this yet.

Dominant language
Python
Stars
5
Forks
22
Avg merge
34m
Merged PRs (30d)
2

Description

Apparently we used to publish the manpages? I came across a reference to https://osbuild.org/man/osbuild-manifest.5 in the image-builder openapi yaml - https://github.com/osbuild/image-builder/blob/main/internal/composer/openapi.v2.yml#L197

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 reading the reference in internal/composer/openapi.v2.yml around line 197 and checking the linked osbuild.org/man/osbuild-manifest.5 URL. Then inspect the website sources for any existing manpage publishing or generation entry points. Done means the missing manpage publication path and the required scope are established, with the referenced URL restored if the source is available.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
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.