Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 2 additions & 19 deletions blog/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,4 @@
=======
---
_build:
render: never
list: never
---
# README

All information about contributing to the Knative documentation has been moved
into a single location:

#### [Go to the How-to guides for Knative docs contributors](https://knative.dev/help/)

**Quick links**:
* [Docs help](https://knative.dev/help/contributor/)
* New content templates:
* [Concept](./docs/contributor/templates/template-concept.md)
* [Procedure](./docs/contributor/templates/template-procedure.md)
* [Troubleshooting](./docs/contributor/templates/template-troubleshooting.md)
* [Blog](./docs/contributor/templates/template-blog-entry.md)
* [Website help](https://knative.dev/help/contributor/publishing)
* [Maintainer help](https://knative.dev/help/maintainer/)
into a single location: [Knative contributor's guide](../docs/help/contributor/readme.md)
46 changes: 40 additions & 6 deletions docs/help/contributor/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,42 @@
# Knative Contributor's Guide (WIP)
# Knative contributor's guide (WIP)

## Table of Contents
## Table of contents

- [Knative MkDocs Contributor Guide](./mkdocs-contributor-guide.md)
- [Knative Style Guide](./style-guide/README.md)
- [Content Re-Use](https://github.com/knative/docs/tree/mkdocs/docs/snippets)
- [Using Shortcodes (TBD)]()

### Getting started

- [Becoming a contributor](./becoming-a-contributor.md)
- [Knative MkDocs contributor guide](./mkdocs-contributor-guide.md)
- [GitHub workflow for Knative documentation](./github.md)


### What to contribute

- [Content structure](./structure.md)
- [Creating blog posts](./creating-blog-posts.md)
- [Creating new documentation](./creating-new-docs.md)
- [Creating code samples](./code-samples.md)


### Templates

- [Blog entry template](./templates/template-blog-entry.md)
- [Concept template](./templates/template-concept.md)
- [Procedure template](./templates/template-procedure.md)
- [Troubleshooting template](./templates/template-troubleshooting.md)


### Style

!!! 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.

If you notice gaps in the style guide or have queries, please post in [the Docs Slack channel](https://knative.slack.com/archives/C9CV04DNJ).

- [Documenting code](./style-guide/documenting-code.md)
- [Formatting standard and conventions](./style-guide/style-and-formatting.md)
- [Voice and language](./style-guide/voice-and-language.md)
- [Word and phrase list](./style-guide/word-and-phrase-list.md)
- [Content re-use](https://github.com/knative/docs/tree/mkdocs/docs/snippets)
- [Using shortcodes (TBD)]()
2 changes: 1 addition & 1 deletion docs/help/contributor/code-samples.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code samples
# Creating code samples

There are currently two general types of content that focus on code samples,
either internal contributor content, or external-facing user content.
Expand Down
2 changes: 1 addition & 1 deletion docs/help/contributor/creating-new-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To contribute new documentation, follow these steps:
- [Blog](templates/template-blog-entry.md) -- Instructions and a template
that you can use to help you post to the Knative blog.
1. [Choose appropriate titles and filenames](#choosing-titles-and-filenames).
1. Write your new content. See the [style guide](style-guide/README.md) to help you with this
1. Write your new content. See the [style guide](/README.md#style) to help you with this
process. Feel free to reach out to the
[DUX working group](https://knative.dev/community/contributing/working-groups/working-groups/#documentation--user-experience) with any questions.
1. Open a PR in the [knative/docs GitHub repository](https://github.com/knative/docs)
Expand Down
14 changes: 0 additions & 14 deletions docs/help/contributor/style-guide/README.md

This file was deleted.