Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Change name of tomlmod serializer #67160

Open
pjuelsgaard opened this issue Jan 16, 2025 · 1 comment
Open

[DOCS] Change name of tomlmod serializer #67160

pjuelsgaard opened this issue Jan 16, 2025 · 1 comment
Labels
Documentation Relates to Salt documentation needs-triage

Comments

@pjuelsgaard
Copy link

Description
It is confusing , when met with the error message Serializer 'tomlmod' not found., when this is the shown name in the documentation

Suggested Fix
Change the module name in th documentation to show:
toml salt.serializers.tomlmod

instead of:
tomlmod salt.serializers.tomlmod

This way, we can still see the hierarchical structure leading down to the module file (salt/serializers/tomlmod.py), but can also see the module name, as seen by salt in the virtual environment.

Type of documentation
Salt Serializer Modules Documentation

Location or format of documentation
[https://docs.saltproject.io/en/latest/ref/serializers/all/index.html]

Additional context
Running Salt 3006.9 on Ubuntu 22.04 and 24.04

@pjuelsgaard pjuelsgaard added Documentation Relates to Salt documentation needs-triage labels Jan 16, 2025
Copy link

welcome bot commented Jan 16, 2025

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey.
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar.
If you have additional questions, email us at [email protected]. We’re glad you’ve joined our community and look forward to doing awesome things with you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation needs-triage
Projects
None yet
Development

No branches or pull requests

1 participant