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

Doc - Remove standalone cluster doc #2862

Merged
merged 2 commits into from
Feb 17, 2022

Conversation

kcoriordan
Copy link
Contributor

@kcoriordan kcoriordan commented Jan 18, 2022

Signed-off-by: kcoriordan [email protected]

What this PR does / why we need it

-Removes standalone cluster topics from table of contents
-Removes references in topics to standalone cluster
-Adds a note (using an include) to the following topics to indicate that they relate to managed clusters and provide a link to the unmanaged cluster doc which will be merged in #2820
- Support matrix
- Getting Started (Management Cluster)
- Planning your installation
- Installing TCE

-Note the standalone cluster topics have not been deleted and are still available through search or saved bookmarks
Related to: #2266, #2820

Details for the Release Notes (PLEASE PROVIDE)


Which issue(s) this PR fixes

Related to: #2266

Describe testing done for PR

Special notes for your reviewer

@kcoriordan kcoriordan requested a review from a team as a code owner January 18, 2022 11:20
@kcoriordan kcoriordan marked this pull request as draft January 18, 2022 11:20
@github-actions github-actions bot added the owner/docs Work executed by VMware documentation team label Jan 18, 2022
@kcoriordan kcoriordan changed the title Remove standalone cluster doc. WIP - Doc - Remove standalone cluster doc Jan 18, 2022
@github-actions github-actions bot added the owner/packages Work executed by a package's maintainer label Jan 18, 2022
@kcoriordan kcoriordan force-pushed the remove-unmanaged-cluster-doc branch from 2252e70 to a269864 Compare January 18, 2022 15:28
@kcoriordan kcoriordan marked this pull request as ready for review January 18, 2022 15:29
@kcoriordan kcoriordan requested a review from a team as a code owner January 18, 2022 15:29
@kcoriordan kcoriordan changed the title WIP - Doc - Remove standalone cluster doc Doc - Remove standalone cluster doc Jan 18, 2022
Copy link
Contributor

@jpmcb jpmcb left a comment

Choose a reason for hiding this comment

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

Not sure why the Netlify site didn't build, but pulled this down, built it with

cd docs/site && hugo build

and looking good to me. Will let others comment as well


Question for @garrying regarding the Algolia search indexing; does the search dynamically update itself based on what's in the site? Will the standalone-cluster pages still show up in the search if we remove it from the TOC?

@garrying
Copy link
Contributor

@jpmcb Search index will dynamically update based on what's in the site (on next crawl). I'm looking into adding a synonym of standalone -> unmanaged to help with surfacing content in Algolia's index.

@joshrosso
Copy link
Contributor

Not sure why the Netlify site didn't build, but pulled this down, built it with

cd docs/site && hugo build

and looking good to me. Will let others comment as well

Question for @garrying regarding the Algolia search indexing; does the search dynamically update itself based on what's in the site? Will the standalone-cluster pages still show up in the search if we remove it from the TOC?

Failed during stage 'checking build content for changes': Canceled build due to no content change

seems Netlify believes there has been no content change, which is surprising. Will kick off tests again.

@kcoriordan kcoriordan force-pushed the remove-unmanaged-cluster-doc branch 2 times, most recently from 2ef957b to 062ec8a Compare January 19, 2022 17:47
@kcoriordan
Copy link
Contributor Author

preview here: https://deploy-preview-2862--quirky-franklin-8969be.netlify.app/docs/latest/docker-monitoring-stack/

not sure why the Netlify link doesn't show in checks, this happens sometimes and I manually add the PR# to the Netlify preview URL

jpmcb
jpmcb previously approved these changes Jan 19, 2022
Copy link
Contributor

@jpmcb jpmcb left a comment

Choose a reason for hiding this comment

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

This looks good to me! Do we want to pull the trigger on getting these docs out? My vote is yes, sooner the better.

@kcoriordan
Copy link
Contributor Author

@jpmcb fixed merge conflict

@jpmcb
Copy link
Contributor

jpmcb commented Jan 31, 2022

@joshrosso - thoughts on getting this out now? Or do we want to wait on this after v0.10.0? I think it'd be fine to go out now

@qnetter
Copy link
Contributor

qnetter commented Jan 31, 2022

When do we currently plan on starting to version the docs?

@joshrosso
Copy link
Contributor

joshrosso commented Feb 1, 2022

When do we currently plan on starting to version the docs?

#882 - v0.11.0

@kcoriordan kcoriordan force-pushed the remove-unmanaged-cluster-doc branch from 1fb7724 to 1fc3d88 Compare February 11, 2022 11:46
Signed-off-by: kcoriordan <[email protected]>

change title

Signed-off-by: kcoriordan <[email protected]>
@kcoriordan kcoriordan force-pushed the remove-unmanaged-cluster-doc branch from 5a74b64 to 6e1174a Compare February 11, 2022 12:54
jpmcb
jpmcb previously approved these changes Feb 16, 2022
Copy link
Contributor

@davidvonthenen davidvonthenen left a comment

Choose a reason for hiding this comment

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

Resolved merge conflict with this commit:
b983d07

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 like everything is covered.

@stmcginnis stmcginnis merged commit 51c3367 into vmware-tanzu:main Feb 17, 2022
stmcginnis pushed a commit to stmcginnis/community-edition that referenced this pull request Mar 21, 2022
Signed-off-by: kcoriordan <[email protected]>
Co-authored-by: David vonThenen <[email protected]>
(cherry picked from commit 51c3367)
stmcginnis added a commit that referenced this pull request Mar 21, 2022
* Update architecture documentation. (#3120)

Signed-off-by: kcoriordan <[email protected]>
(cherry picked from commit 4bd3673)

* Fix broken link in docs. (#3168)

Signed-off-by: kcoriordan <[email protected]>
(cherry picked from commit af86af1)

* Update OVA links and graphics in doc. (#3122)

Signed-off-by: kcoriordan <[email protected]>
(cherry picked from commit dbbc030)

* Add missing separator in glossary section (#3147)

Signed-off-by: Garry Ing <[email protected]>
(cherry picked from commit ec0f5fa)

* Standardize adopters logos (#3161)

The current logos included were quite large, so with the rendered view
they took up a lot of the screen. This updates our two existing logos to
be the same, smaller, width so they are a more reasonable size in the
rendered view.

This also adds a white background to the ITG logo so it is easier to
view on systems with dark mode enabled.

Signed-off-by: Sean McGinnis <[email protected]>
(cherry picked from commit 723fae7)

* Add getting started guide for unmanaged cluster (#2820)

* add gettinging start guide for unmanaged cluster

This commit introduces the getting started guide for unmanaged cluster.
This replaces (in the TOC) the existing standalone-cluster docs.

Signed-off-by: joshrosso <[email protected]>

* Update docs/site/content/docs/assets/unmanaged-desc.md

committing change

Co-authored-by: Kay ORiordan <[email protected]>

Co-authored-by: David vonThenen <[email protected]>
Co-authored-by: Kay ORiordan <[email protected]>
(cherry picked from commit c695232)

* Update 05-tce-10-available.md (#3158)

Fix spacing mdlint issue

Update 05-tce-10-available.md

Add unmanaged cluster demo

Update 05-tce-10-available.md

Add in two missing hyperlinks.

Update 05-tce-10-available.md

Correct emphasis instead of heading

Update 05-tce-10-available.md

Correct bullet point linting

Add v10 blog and images

Add v10 blog and images

(cherry picked from commit 25fcaed)

* Remove standalone cluster doc. (#2862)

Signed-off-by: kcoriordan <[email protected]>
Co-authored-by: David vonThenen <[email protected]>
(cherry picked from commit 51c3367)

* Add download data for v0.10.0 to website (#3153)

* Create v0-10-0.yml

* Update v0-10-0.yml

Updated hashes and sizes.

(cherry picked from commit 8cb7326)

* Document chocolatey release commands (#3172)

Signed-off-by: Nolan Brubaker <[email protected]>
(cherry picked from commit db34736)

* Correct casing of /etc/kubernetes path (#3206)

Our troubleshooting docs walk through how to exec into a pod in order to
run kubectl commands. As part of this, we have the user copy the
admin.conf file over so it doesn't need to be specified as the
`--kubeconfig` when running commands. The example command we give for
them to copy and paste had a type where "Kuberenetes" was capitalized in
that path, so just pasting that command would fail to find the file.
This changes that path to the correct all-lowercase
`/etc/kubernetes/admin.conf`.

Signed-off-by: Sean McGinnis <[email protected]>
(cherry picked from commit 2199141)

* Adds missing step to Contour guide (#3096)

Signed-off-by: kcoriordan <[email protected]>
(cherry picked from commit 62fa9d7)

* Update Azure image name in doc. (#3318)

Signed-off-by: kcoriordan <[email protected]>
(cherry picked from commit 53c87be)

* Removes "standalone" from diagnostics README (#3461)

Signed-off-by: John McBride <[email protected]>
(cherry picked from commit 424013f)

* Doc improvements for Getting Started Guide (#3459)

Signed-off-by: kcoriordan <[email protected]>
(cherry picked from commit d58bf19)

* prereq-windows(doc): Fix link to install docker on windows (#3549)

Fix typo of #4255dc60a37

Signed-off-by: Alexis La Goutte <[email protected]>
(cherry picked from commit 112e4fc)

* Fix merge conflict with v0.10 download data

Signed-off-by: Sean McGinnis <[email protected]>

Co-authored-by: Kay ORiordan <[email protected]>
Co-authored-by: Garry Ing <[email protected]>
Co-authored-by: joshrosso <[email protected]>
Co-authored-by: Nigel Brown <[email protected]>
Co-authored-by: Roger Klorese <[email protected]>
Co-authored-by: Nolan Brubaker <[email protected]>
Co-authored-by: John McBride <[email protected]>
Co-authored-by: Alexis La Goutte <[email protected]>
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 owner/packages Work executed by a package's maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants