66 lines
2.5 KiB
Markdown
66 lines
2.5 KiB
Markdown
---
|
|
title: Suggesting content improvements
|
|
slug: suggest-improvements
|
|
content_type: concept
|
|
weight: 10
|
|
card:
|
|
name: contribute
|
|
weight: 20
|
|
---
|
|
|
|
<!-- overview -->
|
|
|
|
If you notice an issue with Kubernetes documentation, or have an idea for new content, then open an issue. All you need is a [GitHub account](https://github.com/join) and a web browser.
|
|
|
|
In most cases, new work on Kubernetes documentation begins with an issue in GitHub. Kubernetes contributors
|
|
then review, categorize and tag issues as needed. Next, you or another member
|
|
of the Kubernetes community open a pull request with changes to resolve the issue.
|
|
|
|
|
|
|
|
<!-- body -->
|
|
|
|
## Opening an issue
|
|
|
|
If you want to suggest improvements to existing content, or notice an error, then open an issue.
|
|
|
|
1. Go to the bottom of the page and click the **Create an Issue** button. This redirects you
|
|
to a GitHub issue page pre-populated with some headers.
|
|
2. Describe the issue or suggestion for improvement. Provide as many details as you can.
|
|
3. Click **Submit new issue**.
|
|
|
|
After submitting, check in on your issue occasionally or turn on GitHub notifications.
|
|
Reviewers and other community members might ask questions before
|
|
they can take action on your issue.
|
|
|
|
## Suggesting new content
|
|
|
|
If you have an idea for new content, but you aren't sure where it should go, you can
|
|
still file an issue. Either:
|
|
|
|
- Choose an existing page in the section you think the content belongs in and click **Create an issue**.
|
|
- Go to [GitHub](https://github.com/kubernetes/website/issues/new/) and file the issue directly.
|
|
|
|
## How to file great issues
|
|
|
|
|
|
Keep the following in mind when filing an issue:
|
|
|
|
- Provide a clear issue description. Describe what specifically is missing, out of date,
|
|
wrong, or needs improvement.
|
|
- Explain the specific impact the issue has on users.
|
|
- Limit the scope of a given issue to a reasonable unit of work. For problems
|
|
with a large scope, break them down into smaller issues. For example, "Fix the security docs"
|
|
is too broad, but "Add details to the 'Restricting network access' topic" is specific enough
|
|
to be actionable.
|
|
- Search the existing issues to see if there's anything related or similar to the
|
|
new issue.
|
|
- If the new issue relates to another issue or pull request, refer to it
|
|
either by its full URL or by the issue or pull request number prefixed
|
|
with a `#` character. For example, `Introduced by #987654`.
|
|
- Follow the [Code of Conduct](/community/code-of-conduct/). Respect your
|
|
fellow contributors. For example, "The docs are terrible" is not
|
|
helpful or polite feedback.
|
|
|
|
|