Project

Profile

Help

Task #6371

Add plugin writer docs for setting up a Repository

Added by daviddavis 7 months ago. Updated 20 days ago.

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

0%

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

Description

The Plugin Walkthrough[0] has information about about how to set up different classes that the plugin writer needs to define like Remotes, Content, etc. It doesn't mention Repositories though. Below are some suggestions about what this section should contain.

CONTENT_TYPES

  • Plugin writers need to set CONTENT_TYPES with the content types that the Repository can contain.

finalize_new_version()

  • Plugin writers can override finalize_new_version() on Repository to validate/munge content
  • They can call remove_duplicates() to remove duplicates based on repo_key_fields
  • There are validation methods in repo_version_utils they can use too (eg validate_repo_version())

[0] https://docs.pulpproject.org/plugins/plugin-writer/plugin-walkthrough.html

History

#1 Updated by daviddavis 7 months ago

  • Tags Documentation added

#2 Updated by bmbouter 7 months ago

Is there a way to link to the area of the docs these would be added to? Sometimes picking that can be confusing. Other than that detail this looks great.

#3 Updated by daviddavis 7 months ago

  • Description updated (diff)

#4 Updated by bmbouter 7 months ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes

Thank you for writing this up; it looks good.

#5 Updated by daviddavis 7 months ago

  • Subject changed from Add docs for finalizing a repo version to Add plugin writer docs for setting up a Repository
  • Description updated (diff)

#6 Updated by ipanova@redhat.com 7 months ago

  • Tags Backlog added
  • Tags deleted (Documentation)

#7 Updated by ipanova@redhat.com 7 months ago

  • Sprint Candidate changed from Yes to No

#8 Updated by fao89 7 months ago

  • Tracker changed from Issue to Task
  • % Done set to 0

#9 Updated by ipanova@redhat.com 5 months ago

  • Tags deleted (Backlog)

#10 Updated by daviddavis 20 days ago

  • Tags Documentation added

Please register to edit this issue

Also available in: Atom PDF