-
Notifications
You must be signed in to change notification settings - Fork 127
Restructure README and documentation for better project introduction #1697
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
Conversation
| ================ | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is a TODO leftover here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will be updated once #1697 is merged
| ================== | ||
|
|
||
| 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>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
another TODO
| * 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
point to the current TSC member list and roles and responsibilites here:
https://github.com/EVerest/EVerest/blob/main/tsc/MEMBERS.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adressed it
b20d654 to
5274596
Compare
…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 <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
16dc83f to
9c91fa5
Compare
Signed-off-by: Piet Gömpel <[email protected]>
Describe your changes
Issue ticket number and link
Checklist before requesting a review