From c11fc2a71fd13b96f1224710b8ee536e211bc391 Mon Sep 17 00:00:00 2001 From: Richard Wall Date: Thu, 10 Mar 2022 11:12:30 +0000 Subject: [PATCH 1/3] Move the meetings and slack information to a separate page Signed-off-by: Richard Wall --- content/en/docs/contributing/_index.md | 20 +----------------- content/en/docs/contributing/talk-to-us.md | 24 ++++++++++++++++++++++ 2 files changed, 25 insertions(+), 19 deletions(-) create mode 100644 content/en/docs/contributing/talk-to-us.md diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 0378501f4e..92eb04b0cf 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -27,24 +27,6 @@ external cert-manager components: Hello new or existing contributor! Welcome to our contributors documentation, this is the place where we document all our processes -as well as how to compile, run and test cert-manager and all it's components. +as well as how to compile, run and test cert-manager and all its components. This document sometimes can get out of date due to changes in the code and/or tooling. PRs to this part are also very welcome if you happen to find an out of date part. - -## Meetings - -All cert-manager meetings are open for everyone to join. - -To get invites you can subscribe to [our mailing list](https://groups.google.com/forum/#!forum/cert-manager-dev). - -We have 2 regular repeating meetings: - -* daily stand-up meetings [on Google Meet](https://meet.google.com/eum-fyvt-xpa) at [10:30 London time](http://www.thetimezoneconverter.com/?t=10:30&tz=Europe/London) every weekday -* bi-weekly developer meetings [on Google Meet](https://meet.google.com/abp-bwhk-wxc) at [17:00 London time](http://www.thetimezoneconverter.com/?t=17:00&tz=Europe/London) (for dates, check calendar invites or [meeting notes](https://docs.google.com/document/d/1Tc5t6ylY9dhXAan1OjOoldeaoys1Yh4Ir710ATfBa5U)) - -## Slack - -We have two cert-manager channels on [the Kubernetes Slack](https://slack.k8s.io) which we use to communicate: - -* `cert-manager`: a general channel for all users of cert-manager; use this one for any usage related questions. -* `cert-manager-dev`: a channel for collaboration between cert-manager contributors and maintainers; please only use this for code related questions diff --git a/content/en/docs/contributing/talk-to-us.md b/content/en/docs/contributing/talk-to-us.md new file mode 100644 index 0000000000..30bde9d15b --- /dev/null +++ b/content/en/docs/contributing/talk-to-us.md @@ -0,0 +1,24 @@ +--- +title: "Meet the maintainers" +linkTitle: "talk-to-us" +weight: 70 +type: "docs" +--- + +## Meetings + +All cert-manager meetings are open for everyone to join. + +To get invites you can subscribe to [our mailing list](https://groups.google.com/forum/#!forum/cert-manager-dev). + +We have 2 regular repeating meetings: + +* daily stand-up meetings [on Google Meet](https://meet.google.com/eum-fyvt-xpa) at [10:30 London time](http://www.thetimezoneconverter.com/?t=10:30&tz=Europe/London) every weekday +* bi-weekly developer meetings [on Google Meet](https://meet.google.com/abp-bwhk-wxc) at [17:00 London time](http://www.thetimezoneconverter.com/?t=17:00&tz=Europe/London) (for dates, check calendar invites or [meeting notes](https://docs.google.com/document/d/1Tc5t6ylY9dhXAan1OjOoldeaoys1Yh4Ir710ATfBa5U)) + +## Slack + +We have two cert-manager channels on [the Kubernetes Slack](https://slack.k8s.io) which we use to communicate: + +* `cert-manager`: a general channel for all users of cert-manager; use this one for any usage related questions. +* `cert-manager-dev`: a channel for collaboration between cert-manager contributors and maintainers; please only use this for code related questions From b20e31f678b17074d0928b3bd7432f92349aeec2 Mon Sep 17 00:00:00 2001 From: Richard Wall Date: Thu, 10 Mar 2022 14:31:01 +0000 Subject: [PATCH 2/3] Update some links Signed-off-by: Richard Wall --- content/en/docs/contributing/importing.md | 2 +- content/en/docs/release-notes/release-notes-1.7.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/contributing/importing.md b/content/en/docs/contributing/importing.md index 9478f6e356..66c8959069 100644 --- a/content/en/docs/contributing/importing.md +++ b/content/en/docs/contributing/importing.md @@ -27,7 +27,7 @@ You might need to import cert-manager if you're writing Go code which: - implements an external DNS solver webhook, as in the [webhook-example](https://github.com/cert-manager/webhook-example) - implements an external issuer, as in the [sample-external-issuer](https://github.com/cert-manager/sample-external-issuer) -If you think you really need to import other parts of the code, please do reach out and [talk to us](../#slack) so we're +If you think you really need to import other parts of the code, please do reach out and [talk to us](../talk-to-us/#slack) so we're aware of this need! We'll always try to avoid breakage where we can. ## Module Import Paths diff --git a/content/en/docs/release-notes/release-notes-1.7.md b/content/en/docs/release-notes/release-notes-1.7.md index 277411e8a8..bce3321a27 100644 --- a/content/en/docs/release-notes/release-notes-1.7.md +++ b/content/en/docs/release-notes/release-notes-1.7.md @@ -153,7 +153,7 @@ Thanks again to all open-source contributors with commits in this release, inclu And thanks as usual to [coderanger](https://github.com/coderanger) for helping people out on the [`#cert-manager` Slack channel]; it's a huge help and much appreciated. -[`#cert-manager` Slack channel]: ../../contributing/#slack +[`#cert-manager` Slack channel]: ../../contributing/talk-to-us/#slack ### Changelog since v1.6.0 From 84f4358b114c0b5fec5a606064b48e332ed1aaa2 Mon Sep 17 00:00:00 2001 From: Richard Wall Date: Thu, 10 Mar 2022 16:23:46 +0000 Subject: [PATCH 3/3] Fix the menu item and rename the new page Signed-off-by: Richard Wall --- .../{talk-to-us.md => contact-the-maintainers.md} | 4 ++-- content/en/docs/contributing/importing.md | 6 +++--- content/en/docs/release-notes/release-notes-1.7.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) rename content/en/docs/contributing/{talk-to-us.md => contact-the-maintainers.md} (94%) diff --git a/content/en/docs/contributing/talk-to-us.md b/content/en/docs/contributing/contact-the-maintainers.md similarity index 94% rename from content/en/docs/contributing/talk-to-us.md rename to content/en/docs/contributing/contact-the-maintainers.md index 30bde9d15b..c2874f0479 100644 --- a/content/en/docs/contributing/talk-to-us.md +++ b/content/en/docs/contributing/contact-the-maintainers.md @@ -1,6 +1,6 @@ --- -title: "Meet the maintainers" -linkTitle: "talk-to-us" +title: "Contact the maintainers" +linkTitle: "Contact the maintainers" weight: 70 type: "docs" --- diff --git a/content/en/docs/contributing/importing.md b/content/en/docs/contributing/importing.md index 66c8959069..1000e9f40c 100644 --- a/content/en/docs/contributing/importing.md +++ b/content/en/docs/contributing/importing.md @@ -27,7 +27,7 @@ You might need to import cert-manager if you're writing Go code which: - implements an external DNS solver webhook, as in the [webhook-example](https://github.com/cert-manager/webhook-example) - implements an external issuer, as in the [sample-external-issuer](https://github.com/cert-manager/sample-external-issuer) -If you think you really need to import other parts of the code, please do reach out and [talk to us](../talk-to-us/#slack) so we're +If you think you really need to import other parts of the code, please do reach out and [talk to us](../contact-the-maintainers/#slack) so we're aware of this need! We'll always try to avoid breakage where we can. ## Module Import Paths @@ -37,9 +37,9 @@ migrated to `https://github.com/cert-manager/cert-manager`. This means the Go module import path you need depends on the version of cert-manager you're trying to use. -For cert-manager 1.8 and later, use the new path: +For cert-manager 1.8 and later, use the new path: `github.com/cert-manager/cert-manager` -For cert-manager 1.7 and earlier, including all point releases, use the old path: +For cert-manager 1.7 and earlier, including all point releases, use the old path: `github.com/jetstack/cert-manager` diff --git a/content/en/docs/release-notes/release-notes-1.7.md b/content/en/docs/release-notes/release-notes-1.7.md index bce3321a27..c4c97cb706 100644 --- a/content/en/docs/release-notes/release-notes-1.7.md +++ b/content/en/docs/release-notes/release-notes-1.7.md @@ -153,7 +153,7 @@ Thanks again to all open-source contributors with commits in this release, inclu And thanks as usual to [coderanger](https://github.com/coderanger) for helping people out on the [`#cert-manager` Slack channel]; it's a huge help and much appreciated. -[`#cert-manager` Slack channel]: ../../contributing/talk-to-us/#slack +[`#cert-manager` Slack channel]: ../../contributing/contact-the-maintainers/#slack ### Changelog since v1.6.0