knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Removed broken link and reference to other style guides (#3850)

This commit is contained in:
RichardJJG 2021-06-28 15:07:47 +01:00 committed by GitHub
parent 6ae65b57ac
commit f4d3c7f318
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/help/contributor/style-guide/README.md
View File

@ -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)