skills.rest
netbox-community
netbox-communityOFFICIAL
Explore all skills by this author →
WebsiteGitHub

remove-config-param

Remove NetBox configuration parameters and clean all references.

21.3k|3.1k|Updated Feb 29, 2016
Search Tags:#configuration#netbox#configuration history#parameter removal#documentation cleanup#settings.py#config/parameters.py
One-click install
npx skills add https://github.com/netbox-community/netbox --skill remove-config-param
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: remove-config-param
Source: https://github.com/netbox-community/netbox/tree/main/.claude/skills/remove-config-param
Command: npx skills add https://github.com/netbox-community/netbox --skill remove-config-param

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you correctly remove a configuration parameter from NetBox without breaking startup, UI configuration pages, or application code paths.

Core Features & Use Cases

  • Locate and eliminate all call sites: Ensures no remaining references to the parameter exist across Python code (and templates for static parameters).
  • Remove the parameter definition from NetBox: Deletes the dynamic ConfigParam(...) entry from netbox/netbox/config/parameters.py or removes the static getattr(configuration, ...) mapping and related validation from netbox/netbox/settings.py.
  • Remove user-facing documentation and examples: Updates docs/configuration/index.md, removes the parameter’s ## documentation section, and cleans up netbox/netbox/configuration_example.py so the setting is no longer advertised.

Quick Start

Ask an AI to guide you through removing a parameter called MY_PARAM end-to-end, including code usage cleanup, NetBox parameter deletion, and documentation updates, for whichever type (static or dynamic) you are targeting.

Frequently Asked Questions about remove-config-param

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I safely remove a configuration parameter from NetBox without breaking startup?▼

To safely remove a configuration parameter from NetBox, you must eliminate all code call sites, delete the parameter definition from settings.py or config/parameters.py, and update documentation indexes and configuration examples to prevent broken references.

What is the difference between removing a dynamic ConfigParam and a static setting in settings.py?▼

Removing a dynamic ConfigParam requires deleting its entry from netbox/config/parameters.py and ConfigRevision data, whereas removing a static setting requires deleting the getattr configuration mapping and validation logic from netbox/settings.py.

How do I clean up NetBox documentation when deprecating a configuration setting?▼

To clean up NetBox documentation when deprecating a configuration setting, you must remove the parameter's section from docs/configuration/index.md and delete its corresponding examples from netbox/netbox/configuration_example.py so it is no longer advertised.

Why does NetBox fail to start after I delete a parameter from parameters.py?▼

NetBox fails to start after you delete a parameter from parameters.py because remaining Python code or templates still reference the removed setting, requiring you to locate and eliminate all usage sites before removing the parameter definition.

Can I remove a deprecated NetBox configuration parameter without updating the configuration UI?▼

You cannot remove a deprecated NetBox configuration parameter without updating the configuration UI and configuration_example.py, because failing to clean up user-facing documentation and examples leaves broken references across the application interface.

Related Skills

Explore More Software Engineering Skills→
ZHLX2005ZHLX2005
5

flutter-refactor-workflow

Run flutter analyze after code deletions to fix compilation errors.

Community
Intermediate
netbox-communitynetbox-community
21.3k

remove-model-field

Remove NetBox model fields across API, UI, GraphQL, tests, and migrations.

Official
Advanced
lengoctuong2005lengoctuong2005
5

requesting-code-review

Automate pre-commit code review with security scans, tests, and fixes.

Community
Advanced
VictorHueniVictorHueni

util-docs-audit

Audit repository documentation for staleness, broken references, and deprecated API usage.

Community
Intermediate