Skip to content

[Deprecation] puppet doc Command #330

Description

@silug

Summary

puppet doc is explicitly documented as deprecated and planned for removal.

Evidence

  • lib/puppet/application/doc.rb:66 marks command output as deprecated.
  • lib/puppet/application/doc.rb:77 says it is a deprecated command.
  • lib/puppet/application/doc.rb:86 states it will be removed.

Proposed OpenVox 9 Change

  • Remove Puppet::Application::Doc implementation and command registration.
  • Remove related man/reference docs generated for puppet doc.
  • Keep replacement path documented (puppet-strings) in release notes/migration notes.

Compatibility / Risk

  • Breaking change for users/scripts still invoking puppet doc.
  • Low runtime risk to core agent/server paths.

Implementation Notes

  • Remove command source and any command discovery/registration hooks.
  • Remove tests that target puppet doc; add one test that verifies command is unavailable (or omitted from help).

Acceptance Criteria

  • puppet doc is no longer a valid subcommand.
  • Command help/manpage output no longer advertises puppet doc.
  • No dead references remain in references docs.

Suggested Tests

  • CLI smoke test: command list does not include doc.
  • Negative test: puppet doc exits with unknown-command behavior.

Metadata

Metadata

Assignees

No one assigned

    Labels

    deprecationThis issue pertains to an item/topic which has been deprecated.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    In progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions