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 configuration documentation: deprecations, default locations for Policy file and other config files #850

Open
5 tasks
cstepanian opened this issue Jan 29, 2025 · 0 comments
Labels
product: website Relates to the Hipcheck website type: enhancement New feature or request

Comments

@cstepanian
Copy link
Contributor

The docs on path flags needs to be updated to reflect that:

  • The config TOML format is deprecated
  • The data folder is deprecated
  • There is now a --policy flag

The docs for hc check also need to reflect these changes.

User questions the docs should be able to answer:

  • Where does Hipcheck look for the Hipcheck.kdl policy file by default? (the exact paths will vary depending on platform and environment)
  • What is the purpose of the other config files? (Binary.toml, Langs.toml, Orgs.kdl, Typos.toml)
@cstepanian cstepanian added product: website Relates to the Hipcheck website type: enhancement New feature or request labels Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product: website Relates to the Hipcheck website type: enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

1 participant