Project

Profile

Help

Story #9221

As a user, I want proper documentation

Added by lmjachky 4 months ago. Updated 3 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Sprint/Milestone:
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Target Release - OSTree:
Groomed:
No
Sprint Candidate:
No
Tags:
Sprint:
Sprint 104
Quarter:

Description

Currently, there is no documentation specifying how to use the plugin.

In addition to that, the docs need to be published after releasing the plugin. The nightly job for publishing the docs needs to be enabled in the corresponding GitHub repository as well.

History

#1 Updated by lmjachky 4 months ago

  • Subject changed from As a user, I want a proper documentation to As a user, I want proper documentation

#2 Updated by lmjachky 4 months ago

  • Description updated (diff)

#3 Updated by lmjachky 3 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to lmjachky

Tasklist:

  • Add a simple workflow for uploading a tarball and child commits (note the need to create an artifact).
  • Add a simple workflow for syncing from a remote repository.
  • Update the workflow for publishing repositories.
  • Add a new section for the REST API endpoints.
  • Add a basic overview of all currently supported features (similar to https://docs.pulpproject.org/pulp_container/#features).
  • Add a warning about the beta version.

#4 Updated by lmjachky 3 months ago

  • Sprint set to Sprint 104

#5 Updated by lmjachky 3 months ago

  • Status changed from ASSIGNED to POST

#6 Updated by lmjachky 3 months ago

  • Status changed from POST to MODIFIED

Also available in: Atom PDF