From 23a74cb8a6edb025d1e70f6d4095f2d24c28d8f0 Mon Sep 17 00:00:00 2001 From: grego952 Date: Wed, 20 Mar 2024 11:22:23 +0100 Subject: [PATCH] Apply suggestions from mmiotaj review --- docs/contributing/03-git-workflow.md | 2 +- docs/guidelines/content-guidelines/02-style-and-terminology.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing/03-git-workflow.md b/docs/contributing/03-git-workflow.md index 55c49b43e..791a85c6b 100644 --- a/docs/contributing/03-git-workflow.md +++ b/docs/contributing/03-git-workflow.md @@ -172,7 +172,7 @@ Press `q` to exit the log. ```bash git rebase HEAD~{number} -i # Enter the interactive mode to squash the number of commits. For example, to enter interactive mode and squash the last three commits: git rebase HEAD~3 -i - ``` + ``` Leave the top commit, and squash the remaining ones by changing the `pick` command to `squash`. To change the command, type `cw` and then enter `s` in place of `pick`. Press `esc` to exit the insert mode, move to the line with the next commit, and enter `.` to make the same change there. Repeat the same action with all the remaining commits. When you finish, save the changes and exit the editor by pressing `:wq`. diff --git a/docs/guidelines/content-guidelines/02-style-and-terminology.md b/docs/guidelines/content-guidelines/02-style-and-terminology.md index eab80eb22..5eaedc34a 100644 --- a/docs/guidelines/content-guidelines/02-style-and-terminology.md +++ b/docs/guidelines/content-guidelines/02-style-and-terminology.md @@ -195,7 +195,7 @@ Here is the preferred terminology to use in the Kyma documentation: | **the following** | **below**, **this**, **the described**, ... | or "as shown in the example" | | **the previous**, **earlier** | **above**, **this**, **the described**, ... | or "as shown in the example" | -### Command line Arguments +### Command Line Arguments Use short command line arguments whenever possible.