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

Update include.md #20

Closed
wants to merge 1 commit into from
Closed

Update include.md #20

wants to merge 1 commit into from

Conversation

luigir-it
Copy link

@luigir-it luigir-it commented Mar 5, 2024

include:template directive should use an include template, not a pre-built configuration file (configuration template)

Fix include:template directive
@rcdailey rcdailey requested review from yammes08 and removed request for yammes08 March 5, 2024 20:13
@rcdailey
Copy link
Member

rcdailey commented Mar 5, 2024

Thank you very much for the PR. Please know that the YAML snippets in the reference documentation are not intended to be "functional" or kept in sync with the configuration templates repository. The purpose of the snippets is to show users the overall YAML schema (structure) so that they know how to use it. For that reason, I will close this PR without merging. I'm sorry for the wasted effort. In the future, I recommend opening a discussion or issue before doing work.

@rcdailey rcdailey closed this Mar 5, 2024
@luigir-it
Copy link
Author

Don't worry, I did very little. But since that example may create misunderstandings, I thought it was worth fixing it.
If the problem is "keeping in sync" with the wiki, than you can put a placeholder there, like "include_template", instead of something that may create confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants