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

Getting started guides should be simplified #2893

Closed
kartiklunkad26 opened this issue Jan 20, 2022 · 3 comments · Fixed by #3459
Closed

Getting started guides should be simplified #2893

kartiklunkad26 opened this issue Jan 20, 2022 · 3 comments · Fixed by #3459
Assignees
Labels
kind/docs A change in documentation owner/docs Work executed by VMware documentation team reporting/health/on-track
Milestone

Comments

@kartiklunkad26
Copy link
Contributor

Description

Currently the "Getting Started" section refers to two primary topics - "Managed Clusters" and "Standalone Clusters". Each of these sections include documentation for a few tasks such as installing TCE (through a couple of different methods), creating a cluster on any of the four IaaSes, installing a Tanzu Package.

This ends up making the Getting Started guides quite long. The purpose I think of Getting Started guides is to take an opinionated approach to quickly getting the user up and running. There's also duplication of certain sections across "Getting Started" and "Installation" sections such as "Installing TCE"

Proposal

My proposal is to slightly refactor this section to instead reflect certain tasks that the user might need to do.

  1. Create a managed cluster
  2. Create a unmanaged cluster
  3. Install a Tanzu Package

We can also reference the "installing TCE" step as part of 1 & 2 here to the existing page in the "Installation guide" for it.

This will also create room for new getting started guides such as "Create a workload" that will become available over the next few months.

Happy to collaborate on this!

@kartiklunkad26 kartiklunkad26 added kind/docs A change in documentation triage/needs-triage Needs triage by TCE maintainers labels Jan 20, 2022
@joshrosso
Copy link
Contributor

joshrosso commented Jan 21, 2022

@kartiklunkad26 one item of note, the standalone getting started guide is going away in favor of unamanged-cluster:

#2820

@kcoriordan can you consider this change and the feedback above. Let us know how you'd like to proceed!

@nrb nrb added owner/docs Work executed by VMware documentation team and removed triage/needs-triage Needs triage by TCE maintainers labels Jan 21, 2022
@nrb nrb added this to the icebox milestone Jan 21, 2022
@kcoriordan kcoriordan modified the milestones: icebox, v0.11.0 Feb 8, 2022
@kcoriordan
Copy link
Contributor

thanks @kartiklunkad26 - some great suggestions here. I plan to action these in conjunction with other restructure after v0.10.0 is releases

@kartiklunkad26
Copy link
Contributor Author

Hey @kcoriordan hope we can work on this now! Happy to pair.

@joshrosso joshrosso changed the title [Docs] [Kubernetes Platform Documentation | Tanzu Community Edition](/docs/latest/) Rethinking the "Getting Started" Section Getting started guides should be simplified Mar 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/docs A change in documentation owner/docs Work executed by VMware documentation team reporting/health/on-track
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants