Project

Profile

Help

Task #3058

Write docs about the tasking system

Added by bmbouter about 2 years ago. Updated about 1 month ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

The tasking system is a key part of how pulp works but it's not well documented in terms of the behaviors it provides. Having a basic flow diagram of tasks through the components would be good. Along with some identification of the API endpoints (through links to their docs) can be used to manage tasks.

I'm not sure where this should be, but we don't have much in terms of basic user information as a section. Maybe there should be a top-level section called 'Usage' and a subsection called 'Tasking System'. What do others think about this?

History

#1 Updated by bmbouter about 2 years ago

  • Sprint Candidate changed from No to Yes

#2 Updated by amacdona@redhat.com about 1 year ago

  • Sprint Candidate changed from Yes to No

#3 Updated by amacdona@redhat.com 6 months ago

  • Sprint/Milestone set to 3.0

#4 Updated by amacdona@redhat.com 6 months ago

IMO the "workflows" section could be renamed to "usage" and this would belong there.

#5 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

#6 Updated by bmbouter about 1 month ago

  • Sprint/Milestone deleted (3.0)

Please register to edit this issue

Also available in: Atom PDF