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

Document usage of config files #397

Open
tdurk93 opened this issue Jan 23, 2024 · 2 comments
Open

Document usage of config files #397

tdurk93 opened this issue Jan 23, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation XD Work need to be completed by XD team member.

Comments

@tdurk93
Copy link
Contributor

tdurk93 commented Jan 23, 2024

In CONTRIBUTING.md, we should add an introductory explanation of the various configuration files we use (.secureli.yaml, .secureli/repo-config.yaml, and .pre-commit-config.yaml). This should include the reasoning for splitting configuration across these files, and how they differ from each other.

@tdurk93 tdurk93 added the documentation Improvements or additions to documentation label Jan 23, 2024
@dlolaogundipe
Copy link

Core epic

@blonienc blonienc added the XD Work need to be completed by XD team member. label Mar 18, 2024
@itoltz
Copy link
Contributor

itoltz commented Jun 6, 2024

.secureli/.pre-commit-config.yaml is a config file used by the pre-commit library. I added info about it to the README in #560.

.secureli.yaml is already described in some detail in the README.

AFAIK there isn't any documentation on .secureli/repo-config.yaml.

I don't think it makes sense to add any of the config file documentation to CONTRIBUTING.md. That file is used for providing info to people who want to contribute to the seCureLI project; config file documentation is relevant to end users of seCureLI, and so should probably be in (or be linked from) the README.

@itoltz itoltz self-assigned this Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation XD Work need to be completed by XD team member.
Projects
Status: Done
Development

No branches or pull requests

4 participants