Task #7476: [Docs] Improve plugin API reference section of the guide - Pulp

Actions

Send by e-mail Copy link

Task #7476

closed

[Docs] Improve plugin API reference section of the guide

Added by dalley about 2 years ago. Updated 8 months ago.

Status:

CLOSED - DUPLICATE

Priority:

Low

Assignee:

Category:

Sprint/Milestone:

Start date:

Due date:

% Done:

Estimated time:

Platform Release:

Groomed:

Sprint Candidate:

Tags:

Documentation

Sprint:

Quarter:

Description

Ticket moved to GitHub: "pulp/pulpcore/1933":https://github.com/pulp/pulpcore/issues/1933

https://docs.pulpproject.org/pulpcore/plugins/index.html#plugin-writer-s-guide

Feedback from Gerrod:

Knowing how Pulp works in order to make changes is definitely the most challenging aspect of contributing. I think the writer’s guide does a good job describing all the different aspects of Pulp and plugins. The plugin api reference section is a bit barren though.

I think what he's referring to is that several sections like the models and viewsets have almost no description, but then other sections such as downloaders have a lot of detail.