mirror of
https://github.com/flatcar/scripts.git
synced 2026-05-04 19:56:32 +02:00
Merge pull request #3927 from flatcar/john15321/automated/add-community-docs-and-update-readme
## Summary This PR adds standardized community documentation files and updates the README: ### New files - **`SECURITY.md`** — Links to the [main Flatcar Security Policy](https://github.com/flatcar/Flatcar/blob/main/SECURITY.md) with a section for repo-specific security notes - **`MAINTAINERS.md`** — Links to the [main Flatcar MAINTAINERS file](https://github.com/flatcar/Flatcar/blob/main/MAINTAINERS.md) with a section for repo-specific maintainers - **`GOVERNANCE.md`** — Links to the [main Flatcar Governance document](https://github.com/flatcar/Flatcar/blob/main/governance.md) with a section for repo-specific governance - **`CODE_OF_CONDUCT.md`** — Links to the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) and the [main Flatcar Code of Conduct](https://github.com/flatcar/Flatcar/blob/main/CODE_OF_CONDUCT.md) ### Updated files - **`CONTRIBUTING.md`** — Added a note directing users to the [central Flatcar issue tracker](https://github.com/flatcar/Flatcar/issues) ### README.md updates - Added **Discord** badge ([Flatcar Discord server](https://discord.gg/PMYjFUsJyq)) - Added **OpenSSF Best Practices** badge ([project 10926](https://www.bestpractices.dev/projects/10926)) - Added a note pointing to the [central Flatcar issue tracker](https://github.com/flatcar/Flatcar/issues) - Appended a **Community & Project Documentation** reference section linking to all community docs This change is part of a batch update across all Flatcar repositories to ensure consistent community documentation. Ref: https://github.com/flatcar/Flatcar/issues/1865
This commit is contained in:
Jan Bronicki
GitHub
commit
b362a4252e
9
CODE_OF_CONDUCT.md
Normal file
9
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Code of Conduct
|
||||
|
||||
The Flatcar project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
|
||||
|
||||
For details on how we uphold community standards across all Flatcar repositories, please see the [main Flatcar Code of Conduct](https://github.com/flatcar/Flatcar/blob/main/CODE_OF_CONDUCT.md).
|
||||
|
||||
## Reporting
|
||||
|
||||
If you experience or witness unacceptable behavior, please report it following the process outlined in the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
|
||||
@ -4,6 +4,8 @@ Whether you're fixing a bug, adding a feature, or improving docs — we apprecia
|
||||
|
||||
For more detailed guidelines (finding issues, community meetings, PR lifecycle, commit message format, and more), check out the [main Flatcar CONTRIBUTING guide](https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md).
|
||||
|
||||
If you want to file an issue for any Flatcar repository, please use the [central Flatcar issue tracker](https://github.com/flatcar/Flatcar/issues).
|
||||
|
||||
---
|
||||
|
||||
## Repository Specific Guidelines
|
||||
|
||||
11
GOVERNANCE.md
Normal file
11
GOVERNANCE.md
Normal file
@ -0,0 +1,11 @@
|
||||
# Governance
|
||||
|
||||
For details on the Flatcar project governance model, decision-making process, and roles, please see the [main Flatcar Governance document](https://github.com/flatcar/Flatcar/blob/main/governance.md).
|
||||
|
||||
---
|
||||
|
||||
## Repository-Specific Governance
|
||||
|
||||
Any governance details specific to this repository will be listed here.
|
||||
|
||||
<!-- Add repo-specific governance notes below this line -->
|
||||
@ -1,9 +1,11 @@
|
||||
# Maintainers
|
||||
|
||||
* Kai Lüke @pothos
|
||||
* Gabriel Samfira @gabriel-samfira
|
||||
* Thilo Fromm @t-lo
|
||||
For the current list of maintainers and their responsibilities, please see the [main Flatcar MAINTAINERS file](https://github.com/flatcar/Flatcar/blob/main/MAINTAINERS.md).
|
||||
|
||||
See [Governance](https://github.com/flatcar/Flatcar/blob/main/governance.md) for governance, commit, and vote guidelines as well as maintainer responsibilities. Everybody listed in this file is a committer as per governance definition.
|
||||
---
|
||||
|
||||
The contents of this file are synchronized from [Flatcar/MAINTAINERS.md](https://github.com/flatcar/Flatcar/blob/main/MAINTAINERS.md).
|
||||
## Repository-Specific Maintainers
|
||||
|
||||
Any maintainers specific to this repository will be listed here.
|
||||
|
||||
<!-- Add repo-specific maintainers below this line -->
|
||||
|
||||
18
README.md
18
README.md
@ -1,16 +1,20 @@
|
||||
# Flatcar Container Linux SDK scripts
|
||||
|
||||
<div style="text-align: center">
|
||||
|
||||
[](https://www.flatcar.org/)
|
||||
[](https://discord.gg/PMYjFUsJyq)
|
||||
[](https://app.element.io/#/room/#flatcar:matrix.org)
|
||||
[](https://kubernetes.slack.com/archives/C03GQ8B5XNJ)
|
||||
[](https://x.com/flatcar)
|
||||
[](https://hachyderm.io/@flatcar)
|
||||
[](https://bsky.app/profile/flatcar.org)
|
||||
[](https://www.bestpractices.dev/projects/10926)
|
||||
|
||||
|
||||
> **Note:** To file an issue for any Flatcar repository, please use the [central Flatcar issue tracker](https://github.com/flatcar/Flatcar/issues).
|
||||
</div>
|
||||
|
||||
# Flatcar Container Linux SDK scripts
|
||||
|
||||
Welcome to the scripts repo, your starting place for most things here in the Flatcar Container Linux SDK. To get started you can find our documentation on [the Flatcar docs website][flatcar-docs].
|
||||
|
||||
The SDK can be used to
|
||||
@ -151,3 +155,13 @@ The script `./bootstrap_sdk_container` bootstraps a new SDK tarball using an exi
|
||||
# Automation stubs for continuous integration
|
||||
|
||||
Script stubs for various build stages can be found in the [ci-automation](ci-automation) folder. These are helpful for gluing Flatcar Container Linux builds to a continuous integration system.
|
||||
|
||||
---
|
||||
|
||||
## Community & Project Documentation
|
||||
|
||||
- [Contributing Guidelines](CONTRIBUTING.md) — How to contribute, find issues, and submit pull requests
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md) — Standards for respectful and inclusive community participation
|
||||
- [Security Policy](SECURITY.md) — How to report vulnerabilities and security-related information
|
||||
- [Maintainers](MAINTAINERS.md) — Current project maintainers and their responsibilities
|
||||
- [Governance](GOVERNANCE.md) — Project governance model, decision-making process, and roles
|
||||
|
||||
15
SECURITY.md
Normal file
15
SECURITY.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Security Policy
|
||||
|
||||
The Flatcar project takes security seriously. We appreciate your efforts to responsibly disclose your findings.
|
||||
|
||||
For our full security policy, supported versions, and how to report a vulnerability, please see the [main Flatcar Security Policy](https://github.com/flatcar/Flatcar/blob/main/SECURITY.md).
|
||||
|
||||
**Please do not open public issues for security vulnerabilities.**
|
||||
|
||||
---
|
||||
|
||||
## Repository-Specific Security Notes
|
||||
|
||||
Any security considerations specific to this repository will be listed here.
|
||||
|
||||
<!-- Add repo-specific security notes below this line -->
|
||||
Loading…
x
Reference in New Issue
Block a user