Conversation
…and update CONTRIBUTING.md for better clarity
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request contains several minor improvements and cleanups to documentation, spell-check configuration, and markdown checking scripts. The main focus is on improving the developer experience by clarifying documentation, refining script outputs, and updating custom word lists for spell checking.
Documentation and Developer Workflow Improvements:
CONTRIBUTING.mdby adding a direct link to the "Contributing to ZETA" section, clarifying code block formatting (now usingyamlfor examples), and removing unnecessary blank lines for better readability. [1] [2] [3] [4] [5]docs/user-manual/Anleitungen/ZETA_Guard_Quickstart.mdfor consistency in configuration and directive lists. [1] [2]Spell-Checking and Custom Word List Updates:
ANFTI,kubeconform,kubeval) to.cspell/zeta-words.txtto reduce false positives in spell checks. [1] [2]Script and Tooling Enhancements:
scripts/check-markdown.shby improving log messages, suppressing unnecessary output from tools, and providing clearer error reporting for link checks, markdown linting, and spell checking. Also, warnings for missing tools are now more concise. [1] [2] [3]scripts/lychee.tomlto reduce log verbosity for link checking, making script output less noisy by setting the logging level towarn.