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] Update doc/security/index.rst to link to the SECURITY.md file in the master branch #66881

Open
ScriptAutomate opened this issue Sep 11, 2024 · 0 comments
Assignees
Labels
Documentation Relates to Salt documentation

Comments

@ScriptAutomate
Copy link
Contributor

ScriptAutomate commented Sep 11, 2024

Description

Right now, the SECURITY.md file is representative of the latest updates around contact information and gpg public key for security reporting.

Though, in the Salt docs, we have a duplicate file, doc/security/index.rst, that can be out-of-sync with SECURITY.md.

This .rst file is really a duplicate of the information in SECURITY.md.

Suggested Fix

The doc/security/index.rst file should just link out to the SECURITY.md file within the repo root of the master branch.

Type of documentation

  • Salt documentation

Location or format of documentation

Published docs (coming from doc/security/index.rst of the latest release tag for that particular version, except master reflects the master branch):

The best route for the solution would be to submit a PR against the 3006.x branch with an update to doc/security/index.rst, which will then be included in subsequent merge-forwards.

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

No branches or pull requests

2 participants