Project

Profile

Help

Task #2180

Document the plugin API semver strategy for 3.0

Added by bmbouter about 3 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
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 20

Description

Docs need to be added to convey several points that are new with 3.0.

- Starting with Pulp 3.0 the plugin API which will be versioned differently from platform.
- The plugin API with 3.0 will be governed by semantic versioning
- With 3.0 it will be launched as 0.1 which allows us flexibility to make backwards incompatible changes until the plugin API reaches 1.0
- The docs need to state what the Plugin API is for a given version of Pulp. For example, in 3.0 docs they will state the plugin API is at version 0.1.

A release note on the plugin API should be added which links to the plugin API docs. These points ^ should be near the top of the Plugin API docs.

This assumes that #2179 is already done and adds docs to it specific for 3.0. These should land on 3.0 since they are unique to it.


Checklist


Related issues

Related to Pulp - Task #2179: Document what things are governed by semantic versioning in the 2.y line CLOSED - WONTFIX Actions

History

#1 Updated by bmbouter about 3 years ago

  • Blocked by Task #2179: Document what things are governed by semantic versioning in the 2.y line added

#2 Updated by bmbouter about 3 years ago

  • Sprint Candidate changed from Yes to No

#3 Updated by amacdona@redhat.com about 3 years ago

  • Subject changed from Document that the plugin API semver strategy for 3.0 to Document the plugin API semver strategy for 3.0
  • Groomed changed from No to Yes

#4 Updated by amacdona@redhat.com about 3 years ago

  • Blocked by deleted (Task #2179: Document what things are governed by semantic versioning in the 2.y line)

#5 Updated by amacdona@redhat.com about 3 years ago

  • Related to Task #2179: Document what things are governed by semantic versioning in the 2.y line added

#6 Updated by amacdona@redhat.com about 3 years ago

  • Sprint Candidate changed from No to Yes

#7 Updated by mhrivnak almost 3 years ago

  • Sprint/Milestone set to 29
  • Tags Documentation added

#8 Updated by mhrivnak almost 3 years ago

  • Sprint/Milestone changed from 29 to 30

#9 Updated by mhrivnak over 2 years ago

  • Sprint/Milestone changed from 30 to 36

#10 Updated by mhrivnak over 2 years ago

  • Sprint/Milestone changed from 36 to 37

#11 Updated by jortel@redhat.com over 2 years ago

  • Sprint/Milestone changed from 37 to 38

#12 Updated by bizhang over 2 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bizhang

#13 Updated by mhrivnak over 2 years ago

  • Sprint/Milestone changed from 38 to 39

#14 Updated by bizhang over 2 years ago

  • Status changed from ASSIGNED to POST

#15 Updated by werwty over 2 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#16 Updated by bmbouter over 1 year ago

  • Sprint set to Sprint 20

#17 Updated by bmbouter over 1 year ago

  • Sprint/Milestone deleted (39)

#18 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#19 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF