Skip to content

Update search index registration in the plugin documentation #21709

@pheus

Description

@pheus

Change Type

Correction

Area

Plugins

Proposed Changes

The plugin documentation currently shows registering search indexes with an indexes = [...] list in search.py, while the general search documentation uses @register_search on the SearchIndex class.

Since @register_search is the preferred approach going forward, the plugin documentation should be updated to reflect that. This would keep the examples consistent and make the recommended pattern clearer for plugin authors.

Metadata

Metadata

Assignees

No one assigned

    Labels

    netboxstatus: needs ownerThis issue is tentatively accepted pending a volunteer committed to its implementationtype: documentationA change or addition to the documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions