Project

Profile

Help

Task #3220

Updated by amacdona@redhat.com over 1 year ago

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
Document how 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
add custom views in this task. for creating repository versions. Authors would use these docs when implementing complex upload or copying content with dependency solving.

Back