Skip to content

Commit 0ce50f7

Browse files
committed
fix double bullets in TOC
1 parent 77f05f6 commit 0ce50f7

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

content/en/docs/reference/using-api/deprecation-policy.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,21 @@ reviewers:
44
- lavalamp
55
- thockin
66
title: Kubernetes Deprecation Policy
7+
content_template: templates/concept
78
weight: 40
89
---
910

11+
{{% capture overview %}}
12+
This document details the deprecation policy for various facets of the system.
13+
{{% /capture %}}
14+
15+
{{% capture body %}}
1016
Kubernetes is a large system with many components and many contributors. As
1117
with any such software, the feature set naturally evolves over time, and
1218
sometimes a feature may need to be removed. This could include an API, a flag,
1319
or even an entire feature. To avoid breaking existing users, Kubernetes follows
1420
a deprecation policy for aspects of the system that are slated to be removed.
1521

16-
This document details the deprecation policy for various facets of the system.
17-
1822
## Deprecating parts of the API
1923

2024
Since Kubernetes is an API-driven system, the API has evolved over time to
@@ -52,9 +56,11 @@ Once an API element has been added to an API group at a particular version, it
5256
can not be removed from that version or have its behavior significantly
5357
changed, regardless of track.
5458

55-
Note: For historical reasons, there are 2 "monolithic" API groups - "core" (no
59+
{{< note >}}
60+
**Note:** For historical reasons, there are 2 "monolithic" API groups - "core" (no
5661
group name) and "extensions". Resources will incrementally be moved from these
5762
legacy API groups into more domain-specific API groups.
63+
{{< /note >}}
5864

5965
**Rule #2: API objects must be able to round-trip between API versions in a given
6066
release without information loss, with the exception of whole REST resources
@@ -83,11 +89,13 @@ no less than:**
8389

8490
This covers the maximum supported version skew of 2 releases.
8591

86-
NOTE: Until [#52185](https://github.com/kubernetes/kubernetes/issues/52185) is
92+
{{< note >}}
93+
**Note:** Until [#52185](https://github.com/kubernetes/kubernetes/issues/52185) is
8794
resolved, no API versions that have been persisted to storage may be removed.
8895
Serving REST endpoints for those versions may be disabled (subject to the
8996
deprecation timelines in this document), but the API server must remain capable
9097
of decoding/converting previously persisted data from storage.
98+
{{< /note >}}
9199

92100
**Rule #4b: The "preferred" API version and the "storage version" for a given
93101
group may not advance until after a release has been made that supports both the
@@ -367,3 +375,4 @@ leaders to find the best solutions for those specific cases, always bearing in
367375
mind that Kubernetes is committed to being a stable system that, as much as
368376
possible, never breaks users. Exceptions will always be announced in all
369377
relevant release notes.
378+
{{% /capture %}}

0 commit comments

Comments
 (0)