Project

Profile

Help

Task #3220

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 almost 2 years ago. Updated 6 months ago.

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

100%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation, Plugin Template
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 42

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

Duplicated by Pulp - Story #3173: As a plugin author, I have documentation on how to implement a sync operation for my importer CLOSED - DUPLICATE Actions
Copied to Pulp - Task #3298: Expand plugin writer's guide to include Publication creating actions (including publish) MODIFIED Actions

History

#1 Updated by dkliban@redhat.com almost 2 years ago

  • Parent task set to #3209

#2 Updated by daviddavis almost 2 years ago

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

#3 Updated by dkliban@redhat.com almost 2 years ago

  • Blocked by Story #3173: As a plugin author, I have documentation on how to implement a sync operation for my importer added

#4 Updated by dkliban@redhat.com almost 2 years ago

  • Blocked by deleted (Story #3173: As a plugin author, I have documentation on how to implement a sync operation for my importer)

#5 Updated by amacdona@redhat.com almost 2 years ago

  • Duplicates Refactor #3074: Move sync logic from models to tasks added

#6 Updated by amacdona@redhat.com almost 2 years ago

  • Status changed from NEW to CLOSED - DUPLICATE

#7 Updated by amacdona@redhat.com almost 2 years ago

  • Status changed from CLOSED - DUPLICATE to NEW

#8 Updated by amacdona@redhat.com almost 2 years ago

  • Duplicates deleted (Refactor #3074: Move sync logic from models to tasks)

#9 Updated by amacdona@redhat.com almost 2 years ago

  • Duplicated by Story #3173: As a plugin author, I have documentation on how to implement a sync operation for my importer added

#10 Updated by amacdona@redhat.com almost 2 years ago

  • Subject changed from Expand plugin writer's guide to include repository versions to Expand plugin writer's guide to include RepositoryVersion creating actions (including sync)
  • Tags Pulp 3 added

#11 Updated by amacdona@redhat.com almost 2 years ago

  • Copied to Task #3298: Expand plugin writer's guide to include Publication creating actions (including publish) added

#12 Updated by amacdona@redhat.com almost 2 years ago

  • Groomed changed from Yes to No

#13 Updated by amacdona@redhat.com over 1 year ago

  • Groomed changed from No to Yes
  • Tags Pulp 3 MVP added

#14 Updated by amacdona@redhat.com over 1 year ago

  • Sprint set to Sprint 35

#15 Updated by amacdona@redhat.com over 1 year ago

  • Tags Documentation added

#16 Updated by dkliban@redhat.com over 1 year ago

  • Sprint/Milestone set to 3.0

#17 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 35 to Sprint 36

#18 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 36 to Sprint 37

#19 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 37 to Sprint 38

#20 Updated by amacdona@redhat.com over 1 year ago

  • Project changed from Pulp to 27
  • Sprint/Milestone deleted (3.0)

#21 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 38 to Sprint 39

#22 Updated by amacdona@redhat.com over 1 year ago

  • Description updated (diff)

#23 Updated by amacdona@redhat.com over 1 year ago

When this story is complete, please open a PR against my feature branch for plugin-writer docs

https://github.com/asmacdo/plugin_template/tree/add-plugin-writer-docs

#24 Updated by bizhang over 1 year ago

  • Status changed from NEW to ASSIGNED

#25 Updated by bizhang over 1 year ago

  • Status changed from ASSIGNED to POST

#26 Updated by daviddavis over 1 year ago

  • Assignee set to bizhang

#27 Updated by dkliban@redhat.com over 1 year ago

  • Sprint changed from Sprint 39 to Sprint 40

#28 Updated by rchan about 1 year ago

  • Sprint changed from Sprint 40 to Sprint 41

#29 Updated by rchan about 1 year ago

  • Sprint changed from Sprint 41 to Sprint 42

#30 Updated by dalley about 1 year ago

  • Status changed from POST to MODIFIED

#31 Updated by werwty about 1 year ago

  • % Done changed from 0 to 100

Applied in changeset commit:d73ec31f75db6dfdebab8742982ea350cb0475a8.

#32 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3, Pulp 3 MVP)

#33 Updated by bmbouter 6 months ago

  • Tags Plugin Template added

#34 Updated by bmbouter 6 months ago

  • Project changed from 27 to Pulp

The plugin template Redmine project is being consolidated into the Pulp Redmine project so all issues are being moved over.

#35 Updated by bmbouter 6 months ago

  • Sprint/Milestone set to 3.0

Please register to edit this issue

Also available in: Atom PDF