From 2bc9a8031fe8e33da65677cfeb7b009e01764b79 Mon Sep 17 00:00:00 2001 From: NikitaSkrynnik Date: Fri, 23 Aug 2024 14:33:37 +1100 Subject: [PATCH] fix comminuty tabs + add templates for all docs Signed-off-by: NikitaSkrynnik --- content/community/adopters/_index.md | 5 +- content/community/code_of_conduct/_index.md | 2 +- content/community/contributing/_index.md | 94 +++++++++++- content/community/governance/_index.md | 152 +++++++++++++++++++- content/community/multirepo/_index.md | 18 --- content/community/roadmap/_index.md | 7 +- content/docs/docs/_index.md | 5 - content/docs/docs/adopters.md | 8 -- content/docs/docs/contributing.md | 4 - content/docs/docs/governance.md | 4 - content/docs/docs/roadmap.md | 4 - layouts/partials/community/article.html | 38 ++--- layouts/partials/community/hero.html | 20 +-- 13 files changed, 270 insertions(+), 91 deletions(-) delete mode 100644 content/docs/docs/_index.md delete mode 100644 content/docs/docs/adopters.md delete mode 100644 content/docs/docs/contributing.md delete mode 100644 content/docs/docs/governance.md delete mode 100644 content/docs/docs/roadmap.md diff --git a/content/community/adopters/_index.md b/content/community/adopters/_index.md index 33fb753..dd15140 100644 --- a/content/community/adopters/_index.md +++ b/content/community/adopters/_index.md @@ -4,6 +4,7 @@ date = "2024-08-22" weight = 2 +++ -# Code of Conduct +# Adopters -We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). \ No newline at end of file +- [Meridio](https://github.com/Nordix/Meridio) +- [Meshery](https://github.com/meshery/meshery-nsm) \ No newline at end of file diff --git a/content/community/code_of_conduct/_index.md b/content/community/code_of_conduct/_index.md index 17e8679..0ef6fc5 100644 --- a/content/community/code_of_conduct/_index.md +++ b/content/community/code_of_conduct/_index.md @@ -6,4 +6,4 @@ weight = 3 # Code of Conduct -We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). \ No newline at end of file +We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/content/community/contributing/_index.md b/content/community/contributing/_index.md index 1ed6a9c..9af7c92 100644 --- a/content/community/contributing/_index.md +++ b/content/community/contributing/_index.md @@ -1,9 +1,97 @@ +++ -title = "Contributng" +title = "Contributing" date = "2024-08-22" weight = 4 +showToC = true +++ -# Code of Conduct +# Contributing Guidelines -We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). \ No newline at end of file +The Network Service Mesh project accepts contributions via GitHub pull requests. This document outlines the process +to help get your contribution accepted. + +## Issues + +Any user can open an issue in any repository. We do not have a division of issues into types. It is not recommended to use one issue for several problems. For each problem it is worth opening its own issue. + +## Pull Requests + +All contributions come through pull requests. To submit a proposed change, we recommend following this workflow: + +- Make sure there's an issue raised, which sets the expectations for the contribution you are about to make. +- Fork the relevant repo and create a new branch +- Create your change + - Code changes require tests +- Commit with [DCO sign-off](#developer-certificate-of-origin-signing-your-work) and open a PR +- Wait for the CI process to finish and make sure all checks are green +- A maintainer of the project will be assigned, and you can expect a review within a few days + + +### Developer Certificate of Origin: Signing your work + +#### Every commit needs to be signed + +The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the [DCO](https://developercertificate.org/), reformatted for readability: +``` +By making a contribution to this project, I certify that: + + (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or + + (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or + + (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. + + (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. +``` + +Contributors sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages. + +```text +This is my commit message + +Signed-off-by: Random J Developer +``` + +Git even has a `-s` command line option to append this automatically to your commit message: + +```sh +git commit -s -m 'This is my commit message' +``` + +Each Pull Request is checked whether or not commits in a Pull Request do contain a valid Signed-off-by line. + +#### I didn't sign my commit, now what?! + +No worries - You can easily replay your changes, sign them and force push them! + +```sh +git checkout +git commit --amend --no-edit --signoff +git push --force-with-lease +``` + +## Code of Conduct + +We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). + +## Getting Involved +We encourage discussion on our mailing list and IRC channel and accept pull requests. +### Weekly Meetings +[![Weekly Meeting](https://img.shields.io/badge/Weekly%20Meeting%20Minutes-Tue%208am%20PT-blue.svg?style=plastic)](https://docs.google.com/document/d/1C9NKjo0PWNWypROEO9-Y6haw5h9Xmurvl14SXpciz2Y/edit#heading=h.rc9df0a6n3ng) +[![Calendar](https://img.shields.io/badge/Calendar-Subscribe-blue.svg?style=plastic)](https://calendar.google.com/calendar/embed?src=iae5pl3qbf2g5ehm6jb2h7gv08%40group.calendar.google.com&ctz=America%2FLos_Angeles) +### Communication Channels +[![Mailing List](https://img.shields.io/badge/Mailing%20List-networkservicemesh-blue.svg?style=plastic)](https://groups.google.com/forum/#!forum/networkservicemesh) +[![Slack Channel](https://img.shields.io/badge/Slack:-%23nsm%20on%20CNCF%20Slack-blue.svg?style=plastic&logo=slack)](https://cloud-native.slack.com/messages/CHQNNUPN1/) +[![Slack Channel](https://img.shields.io/badge/Slack:-%23nsm--dev%20on%20CNCF%20Slack-blue.svg?style=plastic&logo=slack)](https://cloud-native.slack.com/messages/CHSKJ4849/) +[![Slack Invite](https://img.shields.io/badge/Slack-CNCF%20Slack%20Invite-blue.svg?style=plastic&logo=slack)](https://slack.cncf.io/) +[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/nservicemesh) + +## Security Policy + +### Reporting a security issue +If you believe you have found a security issue in Network Service Mesh, please send a description of the issue to +`security@networkservicemesh.io`. We will send a confirmation to acknowledge your report, and an additional email with the result of our assessment (normally within 1-2 working days). + +### Supported versions + +Note that Network Service Mesh is developed and maintained on one track, thus we encourage our users to follow our latest releases. For this reason we only investigate whether the reported issue is affecting the latest release of Network Service Mesh and provide a fix in a patch release on top of the latest release. \ No newline at end of file diff --git a/content/community/governance/_index.md b/content/community/governance/_index.md index ef90054..300e630 100644 --- a/content/community/governance/_index.md +++ b/content/community/governance/_index.md @@ -4,6 +4,154 @@ date = "2024-08-22" weight = 5 +++ -# Code of Conduct +# Network Serivce Mesh Project Governance -We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). \ No newline at end of file +The Network Serivce Mesh project is dedicated to creating [TODO:Goals of project]. +This governance explains how the project is run. + +- [Values](#values) +- [Maintainers](#maintainers) +- [Becoming a Maintainer](#becoming-a-maintainer) +- [Meetings](#meetings) +- [CNCF Resources](#cncf-resources) +- [Code of Conduct Enforcement](#code-of-conduct) +- [Security Response Team](#security-response-team) + +## Values + +The Network Service Mesh and its leadership embrace the following values: + +* Openness: Communication and decision-making happens in the open and is discoverable for future + reference. As much as possible, all discussions and work take place in public + forums and open repositories. + +* Fairness: All stakeholders have the opportunity to provide feedback and submit + contributions, which will be considered on their merits. + +* Community over Product or Company: Sustaining and growing our community takes + priority over shipping code or sponsors' organizational goals. Each + contributor participates in the project as an individual. + +* Inclusivity: We innovate through different perspectives and skill sets, which + can only be accomplished in a welcoming and respectful environment. + +* Participation: Responsibilities within the project are earned through + participation, and there is a clear path up the contributor ladder into leadership + positions. + +## Maintainers + +Network Service Mesh Maintainers have write access to the [project GitHub repository](TODO). +They can merge their own patches or patches from others. The current maintainers +can be found in [MAINTAINERS.md](./MAINTAINERS.md). Maintainers collectively manage the project's +resources and contributors. + +This privilege is granted with some expectation of responsibility: maintainers +are people who care about the Network Service Mesh project and want to help it grow and +improve. A maintainer is not just someone who can make changes, but someone who +has demonstrated their ability to collaborate with the team, get the most +knowledgeable people to review code and docs, contribute high-quality code, and +follow through to fix issues (in code or tests). + +A maintainer is a contributor to the project's success and a citizen helping +the project succeed. + +The collective team of all Maintainers is known as the Maintainer Council, which +is the governing body for the project. + +### Becoming a Maintainer + +To become a Maintainer you need to demonstrate the following: + + * commitment to the project: + * participate in discussions, contributions, code and documentation reviews + for [TODO: Time Period] or more, + * perform reviews for [TODO:Number] non-trivial pull requests, + * contribute [TODO:Number] non-trivial pull requests and have them merged, + * ability to write quality code and/or documentation, + * ability to collaborate with the team, + * understanding of how the team works (policies, processes for testing and code review, etc), + * understanding of the project's code base and coding and documentation style. + +A new Maintainer must be proposed by an existing maintainer by sending a message to the +[developer mailing list](TODO: List Link). A simple majority vote of existing Maintainers +approves the application. Maintainers nominations will be evaluated without prejudice +to employer or demographics. + +Maintainers who are selected will be granted the necessary GitHub rights, +and invited to the [private maintainer mailing list](TODO). + +### Removing a Maintainer + +Maintainers may resign at any time if they feel that they will not be able to +continue fulfilling their project duties. + +Maintainers may also be removed after being inactive, failure to fulfill their +Maintainer responsibilities, violating the Code of Conduct, or other reasons. +Inactivity is defined as a period of very low or no activity in the project +for a year or more, with no definite schedule to return to full Maintainer +activity. + +A Maintainer may be removed at any time by a 2/3 vote of the remaining maintainers. + +Depending on the reason for removal, a Maintainer may be converted to Emeritus +status. Emeritus Maintainers will still be consulted on some project matters, +and can be rapidly returned to Maintainer status if their availability changes. + +## Meetings + +Time zones permitting, Maintainers are expected to participate in the public +developer meeting, which occurs +[TODO: Details of regular developer or maintainer meeting here]. + +Maintainers will also have closed meetings in order to discuss security reports +or Code of Conduct violations. Such meetings should be scheduled by any +Maintainer on receipt of a security issue or CoC report. All current Maintainers +must be invited to such closed meetings, except for any Maintainer who is +accused of a CoC violation. + +## CNCF Resources + +Any Maintainer may suggest a request for CNCF resources, either in the +[mailing list](TODO: link to developer/maintainer mailing list), or during a +meeting. A simple majority of Maintainers approves the request. The Maintainers +may also choose to delegate working with the CNCF to non-Maintainer community +members, who will then be added to the [CNCF's Maintainer List](https://github.com/cncf/foundation/blob/main/project-maintainers.csv) +for that purpose. + +## Code of Conduct + +[Code of Conduct](./code-of-conduct.md) +violations by community members will be discussed and resolved +on the [private Maintainer mailing list](TODO). If a Maintainer is directly involved +in the report, the Maintainers will instead designate two Maintainers to work +with the CNCF Code of Conduct Committee in resolving it. + +## Security Response Team + +The Maintainers will appoint a Security Response Team to handle security reports. +This committee may simply consist of the Maintainer Council themselves. If this +responsibility is delegated, the Maintainers will appoint a team of at least two +contributors to handle it. The Maintainers will review who is assigned to this +at least once a year. + +The Security Response Team is responsible for handling all reports of security +holes and breaches according to the [security policy](TODO:Link to security.md). + +## Voting + +While most business in Network Service Mesh is conducted by "[lazy consensus](https://community.apache.org/committers/lazyConsensus.html)", +periodically the Maintainers may need to vote on specific actions or changes. +A vote can be taken on [the developer mailing list](TODO) or +[the private Maintainer mailing list](TODO) for security or conduct matters. +Votes may also be taken at [the developer meeting](TODO). Any Maintainer may +demand a vote be taken. + +Most votes require a simple majority of all Maintainers to succeed, except where +otherwise noted. Two-thirds majority votes mean at least two-thirds of all +existing maintainers. + +## Modifying this Charter + +Changes to this Governance and its supporting documents may be approved by +a 2/3 vote of the Maintainers. \ No newline at end of file diff --git a/content/community/multirepo/_index.md b/content/community/multirepo/_index.md index 91c7e5e..5663a56 100644 --- a/content/community/multirepo/_index.md +++ b/content/community/multirepo/_index.md @@ -6,35 +6,17 @@ showToC = false +++ ## Getting Involved - We encourage discussion on our mailing list and IRC channel and accept pull requests. - ### Weekly Meetings [![Weekly Meeting](https://img.shields.io/badge/Weekly%20Meeting%20Minutes-Tue%208am%20PT-blue.svg?style=plastic)](https://docs.google.com/document/d/1C9NKjo0PWNWypROEO9-Y6haw5h9Xmurvl14SXpciz2Y/edit#heading=h.rc9df0a6n3ng) [![Calendar](https://img.shields.io/badge/Calendar-Subscribe-blue.svg?style=plastic)](https://calendar.google.com/calendar/embed?src=iae5pl3qbf2g5ehm6jb2h7gv08%40group.calendar.google.com&ctz=America%2FLos_Angeles) - ### Communication Channels [![Mailing List](https://img.shields.io/badge/Mailing%20List-networkservicemesh-blue.svg?style=plastic)](https://groups.google.com/forum/#!forum/networkservicemesh) [![Slack Channel](https://img.shields.io/badge/Slack:-%23nsm%20on%20CNCF%20Slack-blue.svg?style=plastic&logo=slack)](https://cloud-native.slack.com/messages/CHQNNUPN1/) [![Slack Channel](https://img.shields.io/badge/Slack:-%23nsm--dev%20on%20CNCF%20Slack-blue.svg?style=plastic&logo=slack)](https://cloud-native.slack.com/messages/CHSKJ4849/) [![Slack Invite](https://img.shields.io/badge/Slack-CNCF%20Slack%20Invite-blue.svg?style=plastic&logo=slack)](https://slack.cncf.io/) [![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/nservicemesh) - - ### Developer Resources - Network Service Mesh is 'multi-repo'. The repos and their relationships are shown below: {{< object class="repoMap" data="/img/multi-repo.svg" type="image/svg+xml" >}} - - -## Security Policy - -### Reporting a security issue - -If you believe you have found a security issue in Network Service Mesh, please send a description of the issue to -`security@networkservicemesh.io`. We will send a confirmation to acknowledge your report, and an additional email with the result of our assessment (normally within 1-2 working days). - -### Supported versions - -Note that Network Service Mesh is developed and maintained on one track, thus we encourage our users to follow our latest releases. For this reason we only investigate whether the reported issue is affecting the latest release of Network Service Mesh and provide a fix in a patch release on top of the latest release. \ No newline at end of file diff --git a/content/community/roadmap/_index.md b/content/community/roadmap/_index.md index 17cb6b3..2acdc9b 100644 --- a/content/community/roadmap/_index.md +++ b/content/community/roadmap/_index.md @@ -1,8 +1,5 @@ +++ title = "Roadmap" date = "2024-08-22" -+++ - -# Code of Conduct - -We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). \ No newline at end of file +weight = 6 ++++ \ No newline at end of file diff --git a/content/docs/docs/_index.md b/content/docs/docs/_index.md deleted file mode 100644 index 8bed476..0000000 --- a/content/docs/docs/_index.md +++ /dev/null @@ -1,5 +0,0 @@ -+++ -title = "Docs" -weight = 5 -summary = "Network Service Mesh (NSM): The Hybrid/Multi-cloud IP Service Mesh" -+++ diff --git a/content/docs/docs/adopters.md b/content/docs/docs/adopters.md deleted file mode 100644 index 94bda30..0000000 --- a/content/docs/docs/adopters.md +++ /dev/null @@ -1,8 +0,0 @@ -+++ -title = "Adopters" -date = "2024-08-22" -+++ - -# Adopters - -- Ericsson \ No newline at end of file diff --git a/content/docs/docs/contributing.md b/content/docs/docs/contributing.md deleted file mode 100644 index 04a5604..0000000 --- a/content/docs/docs/contributing.md +++ /dev/null @@ -1,4 +0,0 @@ -+++ -title = "Contributing" -date = "2024-08-22" -+++ \ No newline at end of file diff --git a/content/docs/docs/governance.md b/content/docs/docs/governance.md deleted file mode 100644 index 0e795d3..0000000 --- a/content/docs/docs/governance.md +++ /dev/null @@ -1,4 +0,0 @@ -+++ -title = "Governance" -date = "2024-08-22" -+++ \ No newline at end of file diff --git a/content/docs/docs/roadmap.md b/content/docs/docs/roadmap.md deleted file mode 100644 index 9fc9fa9..0000000 --- a/content/docs/docs/roadmap.md +++ /dev/null @@ -1,4 +0,0 @@ -+++ -title = "Roadmap" -date = "2024-08-22" -+++ \ No newline at end of file diff --git a/layouts/partials/community/article.html b/layouts/partials/community/article.html index ae61c77..873629d 100644 --- a/layouts/partials/community/article.html +++ b/layouts/partials/community/article.html @@ -1,26 +1,32 @@ {{ $toc := .TableOfContents }} +
-
-
- {{ with $toc }} -
- {{ partial "docs/toc.html" . }} + {{ if eq .Params.showToC true }} +
+
+ {{ with $toc }} +
+ {{ partial "community/toc.html" . }} -
+
+
+ {{ end }} +
+ {{ .Content }} +
- {{ end }} -
- {{ .Content }} -
+ {{ with $toc }} +
+ {{ partial "community/toc.html" . }} +
+ {{ end }}
- - {{ with $toc }} -
- {{ partial "community/toc.html" . }} + {{ else }} +
+ {{ .Content }}
- {{ end }} -
+ {{ end }}
diff --git a/layouts/partials/community/hero.html b/layouts/partials/community/hero.html index 347952b..4a9dd9b 100644 --- a/layouts/partials/community/hero.html +++ b/layouts/partials/community/hero.html @@ -35,10 +35,7 @@ {{ range .Sections }} {{ $title := cond (isset .Params "short") .Params.short .Title }} {{ $isCurrentSection := eq .Title $currentSection }} - {{ $link := (index (where .Pages ".Weight" 1) 0).RelPermalink }} - {{ if not $link }} - {{ $link = (index .Pages.ByDate.Reverse 0).RelPermalink }} - {{ end}} + {{ $link := .Permalink }} {{ $title }} @@ -52,18 +49,3 @@ -
- -