saltstack / saltstack/salt

[DOCS] Many errors in zabbix docs

Open
#60,380 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

doc-ex-missing doc-param-missing documentation help-wanted severity-medium time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
Some examples:

  • template_get has a param templateids but documented as hostids
  • get_object_id_by_params says "by its name" and does not detail that params is a list nor gives an example
  • host_exists has a param hostid but documented as hostids
  • assign_templates doesn't document templates
  • zabbix_usermacro.present has unmatched quotes in the example

Type of documentation
Salt modules

Location or format of documentation
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.zabbix.html#salt.modules.zabbix.get_object_id_by_params

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Salt Zabbix modules documentation, especially get_object_id_by_params and the other entries listed in the issue. Correct the parameter descriptions, missing documentation, and unmatched example quotes, then review the page to confirm every reported discrepancy is resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.