From f4d3c7f318cc4d098fec6e205adfae0c3c907005 Mon Sep 17 00:00:00 2001 From: RichardJJG Date: Mon, 28 Jun 2021 15:07:47 +0100 Subject: [PATCH] Removed broken link and reference to other style guides (#3850) --- docs/help/contributor/style-guide/README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/help/contributor/style-guide/README.md b/docs/help/contributor/style-guide/README.md index 840ca7596..70419426a 100644 --- a/docs/help/contributor/style-guide/README.md +++ b/docs/help/contributor/style-guide/README.md @@ -1,18 +1,14 @@ # Knative Style Guide -!!! note "A note to first-time Contributors" - If you are a first-time contributor, don't feel like you need to understand this entire Style Guide front-to-back in order to make a contribution. Check out the Table of Contents for any content that may be relevant to your contribution. +!!! note "A note to first-time contributors" + You don't need to read the whole Style Guide before contributing to Knative documentation. + Unpolished contributions delivered early are better than perfect contributions delivered late. -Style Guides we adhere to, in priority order: (if one doesn't have the answer you're looking for, check the next) - -1. The Knative Styleguide + [Knative Words and Phrase List](https://docs.google.com/spreadsheets/d/1p1_kBUd6ZvonxHkMcEJPayf6QIpExuFf5cFq0ptar7I/edit#gid=0) (must be in the [Knative Developers Group](https://groups.google.com/forum/#!forum/knative-dev) to view) -2. [The Kubernetes Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/) -!!! tip - If you use any style that isn't included in Knative Style Guide, [please add that information to this document](https://github.com/knative/docs/edit/main/docs/help/contributor/style-guide/README.md) +If you notice gaps in the style guide or have queries, please post in [the Docs Slack channel](https://knative.slack.com/archives/C9CV04DNJ). ## Table of Contents -1. [Page formatting standards](./style-and-formatting.md) +1. [Formatting standards](./style-and-formatting.md) 1. [Voice and language](./voice-and-language.md) -1. [Documenting Code](./documenting-code.md) -1. [Word and Phrase List](./word-and-phrase-list.md) +1. [Documenting code](./documenting-code.md) +1. [Word and phrase list](./word-and-phrase-list.md)