Project

Profile

Help

Task #2180

closed

Document the plugin API semver strategy for 3.0

Added by bmbouter over 7 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
Sprint:
Sprint 20
Quarter:

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.


Related issues

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

Actions
Actions #1

Updated by bmbouter over 7 years ago

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

Updated by bmbouter over 7 years ago

  • Sprint Candidate changed from Yes to No
Actions #3

Updated by amacdona@redhat.com over 7 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
Actions #4

Updated by amacdona@redhat.com over 7 years ago

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

Updated by amacdona@redhat.com over 7 years ago

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

Updated by amacdona@redhat.com over 7 years ago

  • Sprint Candidate changed from No to Yes
Actions #7

Updated by mhrivnak over 7 years ago

  • Sprint/Milestone set to 29
  • Tags Documentation added
Actions #8

Updated by mhrivnak over 7 years ago

  • Sprint/Milestone changed from 29 to 30
Actions #9

Updated by mhrivnak about 7 years ago

  • Sprint/Milestone changed from 30 to 36
Actions #10

Updated by mhrivnak about 7 years ago

  • Sprint/Milestone changed from 36 to 37
Actions #11

Updated by jortel@redhat.com almost 7 years ago

  • Sprint/Milestone changed from 37 to 38
Actions #12

Updated by bizhang almost 7 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bizhang
Actions #13

Updated by mhrivnak almost 7 years ago

  • Sprint/Milestone changed from 38 to 39
Actions #14

Updated by bizhang almost 7 years ago

  • Status changed from ASSIGNED to POST
Actions #15

Updated by werwty almost 7 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100
Actions #16

Updated by bmbouter about 6 years ago

  • Sprint set to Sprint 20
Actions #17

Updated by bmbouter about 6 years ago

  • Sprint/Milestone deleted (39)
Actions #18

Updated by daviddavis almost 5 years ago

  • Sprint/Milestone set to 3.0.0
Actions #19

Updated by bmbouter almost 5 years ago

  • Tags deleted (Pulp 3)
Actions #20

Updated by bmbouter over 4 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF