Skip to content

Commit 31f9550

Browse files
committed
Copy concepts/services-networking/endpoint-slices.md from en/ directory.
1 parent ba3c2c4 commit 31f9550

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Suggesting content improvements
3+
slug: suggest-improvements
4+
content_type: concept
5+
weight: 10
6+
card:
7+
name: contribute
8+
weight: 20
9+
---
10+
11+
<!-- overview -->
12+
13+
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.
14+
15+
In most cases, new work on Kubernetes documentation begins with an issue in GitHub. Kubernetes contributors
16+
then review, categorize and tag issues as needed. Next, you or another member
17+
of the Kubernetes community open a pull request with changes to resolve the issue.
18+
19+
20+
21+
<!-- body -->
22+
23+
## Opening an issue
24+
25+
If you want to suggest improvements to existing content, or notice an error, then open an issue.
26+
27+
1. Go to the bottom of the page and click the **Create an Issue** button. This redirects you
28+
to a GitHub issue page pre-populated with some headers.
29+
2. Describe the issue or suggestion for improvement. Provide as many details as you can.
30+
3. Click **Submit new issue**.
31+
32+
After submitting, check in on your issue occasionally or turn on GitHub notifications.
33+
Reviewers and other community members might ask questions before
34+
they can take action on your issue.
35+
36+
## Suggesting new content
37+
38+
If you have an idea for new content, but you aren't sure where it should go, you can
39+
still file an issue. Either:
40+
41+
- Choose an existing page in the section you think the content belongs in and click **Create an issue**.
42+
- Go to [GitHub](https://github.com/kubernetes/website/issues/new/) and file the issue directly.
43+
44+
## How to file great issues
45+
46+
47+
Keep the following in mind when filing an issue:
48+
49+
- Provide a clear issue description. Describe what specifically is missing, out of date,
50+
wrong, or needs improvement.
51+
- Explain the specific impact the issue has on users.
52+
- Limit the scope of a given issue to a reasonable unit of work. For problems
53+
with a large scope, break them down into smaller issues. For example, "Fix the security docs"
54+
is too broad, but "Add details to the 'Restricting network access' topic" is specific enough
55+
to be actionable.
56+
- Search the existing issues to see if there's anything related or similar to the
57+
new issue.
58+
- If the new issue relates to another issue or pull request, refer to it
59+
either by its full URL or by the issue or pull request number prefixed
60+
with a `#` character. For example, `Introduced by #987654`.
61+
- Follow the [Code of Conduct](/community/code-of-conduct/). Respect your
62+
fellow contributors. For example, "The docs are terrible" is not
63+
helpful or polite feedback.
64+
65+

0 commit comments

Comments
 (0)