Project

Profile

Help

Task #3220

closed

Story #3209: As a user, I have Repository Versions

Expand plugin writer's guide to include RepositoryVersion creating actions (including sync)

Added by dkliban@redhat.com over 6 years ago. Updated over 4 years ago.

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

100%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation, Plugin Template
Sprint:
Sprint 42
Quarter:

Description

The documentation for plugin writers needs to explain that a new repository version should be created any time the content of a repository changes.

There are two places to consider.

A high level explanation of the options (currently, just using RepositoryVersion as a context manager) should be included in the sync documentation in the plugin-writer docs.
https://github.com/asmacdo/plugin_template/blob/add-plugin-writer-docs/docs/plugin-writer/tasks/add-remove.rst

A specific example is included in the sync task in the plugin_template. Please check that the comments are sufficient, and that they match the explanation in the plugin writer docs.
https://github.com/asmacdo/plugin_template/blob/add-plugin-writer-docs/pulp_plugin_template/app/tasks/synchronizing.py#L39

Given that more work is being done with the DeclarativeVersion, keep in mind that what is added by this task will be expanded/revised soon.

Do not include custom views in this task.


Related issues

Has duplicate Pulp - Story #3173: As a plugin author, I have documentation on how to implement a sync operation for my importerCLOSED - DUPLICATE

Actions
Copied to Pulp - Task #3298: Expand plugin writer's guide to include Publication creating actions (including publish)CLOSED - CURRENTRELEASECodeHeeler

Actions

Also available in: Atom PDF