Restructure README and documentation for better project introduction #1697
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ction - Replace detailed installation instructions in README with high-level project overview - Highlight main features and link to comprehensive documentation site - Move community information from docs/source/community-channels.rst to docs/source/project/community.rst - Add new project governance documentation structure with contributing guidelines, governance policy, code of conduct, and security policy - Added stubs for CODE_OF_CONDUCT, CONTRIBUTING, GOVERNANCE, RELEASE and SECURTIY - Update internal documentation links to reflect new structure - Create placeholder for release documentation Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
caller
reviewed
Jan 7, 2026
| ================ | ||
|
|
||
| Project releases will occur on a scheduled basis as agreed to by the | ||
| committers. See :doc:`TODO Release documentation </project/releases/release-and-versioning>` for details. |
Contributor
There was a problem hiding this comment.
there is a TODO leftover here
Pietfried
commented
Jan 7, 2026
| If a committer is no longer interested or cannot perform the committer duties listed above, they | ||
| should volunteer to be moved to emeritus status. In extreme cases this can also occur by a vote of | ||
| the committers per the voting process below. | ||
|
|
Contributor
Author
There was a problem hiding this comment.
TOOD: Add CODEOWNERs section
caller
reviewed
Jan 7, 2026
| ================== | ||
|
|
||
| Since the beginning of 2026 we are releasing versions of EVerest with a cadence of six months. | ||
| The specifics of this release process are outlined in the :doc:`TODO Release Documentation </project/releases/release-and-versioning>`. |
| * Request to become a committer. To do this, please either contact the TSC | ||
| or an existing committer in one of the working group meetings or channels. | ||
|
|
||
| Committer responsibilities |
Contributor
There was a problem hiding this comment.
here we beed anotger category of TSC members with a formal vote. EVereyone can join TSC, but not everyone has a vote. new vorting members are elected by existing voting members.
dann kannst du den text noch ergänzen wie bei den committers das die freiwillig das amt niederlegen können oder rausgevotet werden können vom TSC
Contributor
There was a problem hiding this comment.
point to the current TSC member list and roles and responsibilites here:
https://github.com/EVerest/EVerest/blob/main/tsc/MEMBERS.md
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Issue ticket number and link
Checklist before requesting a review