From 24742b42d42c52d17a39a22ee1181aa97e69faab Mon Sep 17 00:00:00 2001 From: Fish-pro Date: Tue, 31 Jan 2023 18:16:54 +0800 Subject: [PATCH] Optimize the document for readability (#6175) Signed-off-by: Fish-pro --- docs/dev/api/README.md | 4 ++-- docs/dev/troubleshooting/reports.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/dev/api/README.md b/docs/dev/api/README.md index d52eb4008d..2a557130bd 100644 --- a/docs/dev/api/README.md +++ b/docs/dev/api/README.md @@ -35,11 +35,11 @@ New attributes can be added to existing resources without impacting compatibilit ## Deleting an attribute -Attributes cannot be deleted in an version. They should be marked for deprecation and removed after 3 minor releases. +Attributes cannot be deleted in a version. They should be marked for deprecation and removed after 3 minor releases. ## Modifying an attribute -Attributes cannot be modified in an version. The existing attribute should be marked for deprecation and a new attribute should be added following version compatibity guidelines. +Attributes cannot be modified in a version. The existing attribute should be marked for deprecation and a new attribute should be added following version compatibity guidelines. ## Stable References diff --git a/docs/dev/troubleshooting/reports.md b/docs/dev/troubleshooting/reports.md index 2cffe8c767..b749e9046d 100644 --- a/docs/dev/troubleshooting/reports.md +++ b/docs/dev/troubleshooting/reports.md @@ -10,7 +10,7 @@ This will show infos about the resource associated with the report. It can be useful to determine if a particular resource kind is responsible for creating too many reports. -If `APIVERSION`, `KIND` and `SUBJECT` is empty it means the report is orphan and it is an issue if the report is more than a couple minutes old. +If `APIVERSION`, `KIND` and `SUBJECT` is empty it means the report is orphan and it is an issue if the report is more than a couple of minutes old. ```console # list cluster admission reports