Skip to content

Commit b0840ae

Browse files
authored
docs: fix documentation links and references (#5)
1 parent 033c2a4 commit b0840ae

File tree

3 files changed

+31
-34
lines changed

3 files changed

+31
-34
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ We use GitHub to host code, to track issues and feature requests, as well as acc
2929

3030
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
3131

32-
## Report bugs using GitHub's [issue tracker](../../issues)
32+
## Report bugs using GitHub's [issue tracker](https://github.com/PeterVinter/Manage_linux_docker_containers/issues)
3333

34-
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](../../issues/new).
34+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/PeterVinter/Manage_linux_docker_containers/issues/new).
3535

3636
## Write bug reports with detail, background, and sample code
3737

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
![Issues](https://img.shields.io/github/issues/PeterVinter/Manage_linux_docker_containers)
77
![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=white)
88
![Bash](https://img.shields.io/badge/Bash-4EAA25?style=flat&logo=gnu-bash&logoColor=white)
9-
[![CI](../../actions/workflows/ci.yml/badge.svg)](../../actions/workflows/ci.yml)
10-
[![Release](../../actions/workflows/release.yml/badge.svg)](../../actions/workflows/release.yml)
11-
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/PeterVinter/Manage_linux_docker_containers/graphs/commit-activity)
9+
[![CI](https://github.com/PeterVinter/Manage_linux_docker_containers/actions/workflows/ci.yml/badge.svg)](https://github.com/PeterVinter/Manage_linux_docker_containers/actions/workflows/ci.yml)
10+
[![Release](https://github.com/PeterVinter/Manage_linux_docker_containers/actions/workflows/release.yml/badge.svg)](https://github.com/PeterVinter/Manage_linux_docker_containers/actions/workflows/release.yml)
11+
[![Maintenance](https://img.shields.io/maintenance/yes/2024)](https://github.com/PeterVinter/Manage_linux_docker_containers/graphs/commit-activity)
1212
![Tests](https://img.shields.io/badge/Tests-Passing-success)
1313
[![made-with-bash](https://img.shields.io/badge/Made%20with-Bash-1f425f.svg)](https://www.gnu.org/software/bash/)
1414
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
@@ -77,7 +77,7 @@ Logs are stored in:
7777
### Project Management
7878

7979
We use GitHub Projects to track the development of features and improvements. You can find our project board at:
80-
[Manage_linux_docker_containers Development](https://github.com/users/PeterVinter/projects/1/views/1)
80+
[Project Board](https://github.com/PeterVinter/Manage_linux_docker_containers/projects)
8181

8282
For detailed GitHub CLI commands and workflows, see our [GitHub CLI Workflow Guide](docs/github_cli_workflow.md).
8383

@@ -104,10 +104,10 @@ For detailed GitHub CLI commands and workflows, see our [GitHub CLI Workflow Gui
104104
- Assignees: Developer working on the issue
105105

106106
4. **Contributing**
107-
- Check the [Project Board](https://github.com/users/PeterVinter/projects/1/views/1) for available tasks
107+
- Check the [Project Board](https://github.com/PeterVinter/Manage_linux_docker_containers/projects) for available tasks
108108
- Read [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines
109109
- Follow the issue template when creating new issues
110-
- Reference issues in pull requests
110+
- [Create a new issue](https://github.com/PeterVinter/Manage_linux_docker_containers/issues/new) to report bugs or suggest features
111111

112112
### Automated Releases
113113

@@ -168,4 +168,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
168168

169169
## Support
170170

171-
If you encounter any problems or have suggestions, please [open an issue](../../issues/new).
171+
If you encounter any problems or have suggestions, please [open an issue](https://github.com/PeterVinter/Manage_linux_docker_containers/issues/new).

SECURITY.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,37 @@
22

33
## Supported Versions
44

5-
Use this section to tell people about which versions of your project are currently being supported with security updates.
5+
We maintain security updates for the following versions:
66

77
| Version | Supported |
88
| ------- | ------------------ |
9-
| 1.0.3 | :white_check_mark: |
10-
| 1.0.2 | :white_check_mark: |
11-
| 1.0.1 | :x: |
9+
| 2.0.x | :white_check_mark: |
10+
| 1.0.x | :white_check_mark: |
11+
| < 1.0 | :x: |
1212

13-
## Reporting a Security Vulnerability
13+
## Reporting a Vulnerability
1414

15-
We take the security of Docker Safe Shutdown seriously. If you believe you have found a security vulnerability, please report it to us as described below.
15+
We take the security of our Docker container management tools seriously. If you discover a security vulnerability, please follow these steps:
1616

17-
**Please do not report security vulnerabilities through public GitHub issues.**
17+
1. **Do Not** create a public GitHub issue for the vulnerability.
18+
2. Submit your findings through one of these channels:
19+
- Open a [Security Advisory](https://github.com/PeterVinter/Manage_linux_docker_containers/security/advisories/new)
20+
- Email the maintainers at peter.vinter.security@gmail.com
1821

19-
Instead, please report them via email to [security@petervinter.com] or open a private security advisory at https://github.com/PeterVinter/docker-safe-shutdown/security/advisories/new
22+
We follow the principles of [Responsible Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure).
2023

21-
You should receive a response within 48 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
24+
### What to Include
2225

23-
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
26+
When reporting a vulnerability, please include:
2427

25-
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
26-
* Full paths of source file(s) related to the manifestation of the issue
27-
* The location of the affected source code (tag/branch/commit or direct URL)
28-
* Any special configuration required to reproduce the issue
29-
* Step-by-step instructions to reproduce the issue
30-
* Proof-of-concept or exploit code (if possible)
31-
* Impact of the issue, including how an attacker might exploit the issue
28+
- A brief description of the vulnerability
29+
- Steps to reproduce the issue
30+
- Potential impact
31+
- Any suggested fixes (if available)
3232

33-
This information will help us triage your report more quickly.
33+
### Our Commitment
3434

35-
## Preferred Languages
36-
37-
We prefer all communications to be in English.
38-
39-
## Policy
40-
41-
We follow the principle of [Responsible Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure).
35+
- We will acknowledge receipt within 48 hours
36+
- We will provide regular updates on our progress
37+
- We will notify you when the vulnerability is fixed
38+
- We will publicly acknowledge your responsible disclosure (unless you prefer to remain anonymous)

0 commit comments

Comments
 (0)