Skip to content

docs: fix documentation links and references #5

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 19, 2024
Merged

docs: fix documentation links and references #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ We use GitHub to host code, to track issues and feature requests, as well as acc

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.

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

We use GitHub issues to track public bugs. Report a bug by [opening a new issue](../../issues/new).
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).

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

Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
![Issues](https://img.shields.io/github/issues/PeterVinter/Manage_linux_docker_containers)
![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=white)
![Bash](https://img.shields.io/badge/Bash-4EAA25?style=flat&logo=gnu-bash&logoColor=white)
[![CI](../../actions/workflows/ci.yml/badge.svg)](../../actions/workflows/ci.yml)
[![Release](../../actions/workflows/release.yml/badge.svg)](../../actions/workflows/release.yml)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/PeterVinter/Manage_linux_docker_containers/graphs/commit-activity)
[![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)
[![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)
[![Maintenance](https://img.shields.io/maintenance/yes/2024)](https://github.com/PeterVinter/Manage_linux_docker_containers/graphs/commit-activity)
![Tests](https://img.shields.io/badge/Tests-Passing-success)
[![made-with-bash](https://img.shields.io/badge/Made%20with-Bash-1f425f.svg)](https://www.gnu.org/software/bash/)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
Expand Down Expand Up @@ -77,7 +77,7 @@ Logs are stored in:
### Project Management

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

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

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

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

### Automated Releases

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

## Support

If you encounter any problems or have suggestions, please [open an issue](../../issues/new).
If you encounter any problems or have suggestions, please [open an issue](https://github.com/PeterVinter/Manage_linux_docker_containers/issues/new).
47 changes: 22 additions & 25 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,37 @@

## Supported Versions

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

| Version | Supported |
| ------- | ------------------ |
| 1.0.3 | :white_check_mark: |
| 1.0.2 | :white_check_mark: |
| 1.0.1 | :x: |
| 2.0.x | :white_check_mark: |
| 1.0.x | :white_check_mark: |
| < 1.0 | :x: |

## Reporting a Security Vulnerability
## Reporting a Vulnerability

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.
We take the security of our Docker container management tools seriously. If you discover a security vulnerability, please follow these steps:

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

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
We follow the principles of [Responsible Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure).

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.
### What to Include

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:
When reporting a vulnerability, please include:

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

This information will help us triage your report more quickly.
### Our Commitment

## Preferred Languages

We prefer all communications to be in English.

## Policy

We follow the principle of [Responsible Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure).
- We will acknowledge receipt within 48 hours
- We will provide regular updates on our progress
- We will notify you when the vulnerability is fixed
- We will publicly acknowledge your responsible disclosure (unless you prefer to remain anonymous)