Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Adding doc detail for Tanzu CLI uninstall #1811

Merged
merged 1 commit into from
Sep 17, 2021
Merged

Conversation

kcoriordan
Copy link
Contributor

Signed-off-by: kcoriordan koriordan@vmware.com

Adds detail on paths uninsalled when Tanzu uninstall.sh is run
Adds links to uninstall standalone/management clusters

Details for the Release Notes (PLEASE PROVIDE)


Which issue(s) this PR fixes

Fixes: #1687

Describe testing done for PR

Special notes for your reviewer

@kcoriordan kcoriordan requested a review from a team as a code owner September 17, 2021 17:03
@github-actions github-actions bot added the owner/docs Work executed by VMware documentation team label Sep 17, 2021
@kcoriordan kcoriordan requested a review from jpmcb September 17, 2021 17:03
@kcoriordan kcoriordan marked this pull request as draft September 17, 2021 17:03
@kcoriordan kcoriordan marked this pull request as ready for review September 17, 2021 17:11
@kcoriordan
Copy link
Contributor Author

@jpmcb - I don't know how to fix the mdlindt error?

@kcoriordan kcoriordan marked this pull request as draft September 17, 2021 18:16
Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some pretty minor errors from the mdlinting. Here is a good reference to see what those error codes mean:

https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

So from the job output:

docs/site/content/docs/latest/cli-uninstall.md:13 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/site/content/docs/latest/cli-uninstall.md:14 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "The `~/.local/share/tce` folde..."]
docs/site/content/docs/latest/cli-uninstall.md:15:1 MD019/no-multiple-space-atx Multiple spaces after hash on atx style heading [Context: "##  MacOS"]
docs/site/content/docs/latest/cli-uninstall.md:15 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "##  MacOS"]
docs/site/content/docs/latest/cli-uninstall.md:17 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/site/content/docs/latest/cli-uninstall.md:24 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/site/content/docs/latest/cli-uninstall.md:27 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/site/content/docs/latest/cli-uninstall.md:41 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

Looks like most are MD012: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md012---multiple-consecutive-blank-lines

With MD032, MD019, and MD022 all coming from around the first issue on lines 13-16.

So, should be able to edit those to correct the formatting, then just:

# edit file
git add .
git commit -s --amend
git push -f origin doc-uninstall-detail

@kcoriordan kcoriordan force-pushed the doc-uninstall--detail branch 2 times, most recently from c1af15a to b92a333 Compare September 17, 2021 18:44
Signed-off-by: kcoriordan <koriordan@vmware.com>
@kcoriordan kcoriordan force-pushed the doc-uninstall--detail branch from b92a333 to e929126 Compare September 17, 2021 18:50
@kcoriordan
Copy link
Contributor Author

@stmcginnis thanks very much, very helpful as always - sorted now.

@kcoriordan kcoriordan marked this pull request as ready for review September 17, 2021 18:53
Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@stmcginnis stmcginnis merged commit 10d718f into main Sep 17, 2021
@stmcginnis stmcginnis deleted the doc-uninstall--detail branch September 17, 2021 19:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-not-required owner/docs Work executed by VMware documentation team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Give details on what uninstall does uninstall
3 participants