documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Adjusted documentation about packages to v1/v2 instead of old/new

Open craigcomstock opened this issue 1 year ago • 12 comments

We felt in discussion internally that v1/v2 was easier to understand especially if we also include how they are implemented:

v1 packages promise (package_method) v2 packages promise (package_module)

This leaves easier room for a v3 if that ever needs to happen.

v1(old) packages promise still has several advantages:

  • support for more different package managers such as pip, brew, etc.
  • support for bulk operations by default

Ticket: CFE-4315 Changelog: title

craigcomstock avatar Feb 22 '24 19:02 craigcomstock

@cf-bottom jenkins please

craigcomstock avatar Feb 22 '24 19:02 craigcomstock

this is related to https://github.com/cfengine/core/pull/5434 (CFE-4315) but isn't dependent on it from a code point of view so am not putting "together" so I can get a fast docs build.

craigcomstock avatar Feb 22 '24 19:02 craigcomstock

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/537/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-537/output/_site/

cf-bottom avatar Feb 22 '24 19:02 cf-bottom

@cf-bottom jenkins another go please

craigcomstock avatar Feb 22 '24 19:02 craigcomstock

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/538/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-538/output/_site/

cf-bottom avatar Feb 22 '24 19:02 cf-bottom

@cf-bottom jenkins

craigcomstock avatar Feb 22 '24 20:02 craigcomstock

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/539/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-539/output/_site/

cf-bottom avatar Feb 22 '24 20:02 cf-bottom

@cf-bottom jenkins

craigcomstock avatar Feb 22 '24 21:02 craigcomstock

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/540/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-540/output/_site/

cf-bottom avatar Feb 22 '24 21:02 cf-bottom

Build Status

craigcomstock avatar Feb 23 '24 14:02 craigcomstock

Build Status

craigcomstock avatar Feb 23 '24 15:02 craigcomstock

Build Status

craigcomstock avatar Feb 23 '24 17:02 craigcomstock