Project

Profile

Help

Task #3058

closed

Write docs about the tasking system

Added by bmbouter over 5 years ago. Updated over 2 years ago.

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

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:

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?

Also available in: Atom PDF