LFX 2024 Term 3: Add new getting started examples

[frouioui]

Description

For this third term of the 2024 LFX mentorship program, we would like to add more getting started guides and code examples to help new users of Vitess to get up to speed with the project. With the project being complex as it is, its lack of examples makes it harder for people to adopt. We would then like to add a new guide on at least the following topics:

• Backups
• VReplication
• FKs
• Managed
• Improve the troubleshooting / common issues guide

More categories can be added as we realize we need some guides in some areas. The goal of the internship is to quickly grow the mentee's understanding of Vitess have them contribute real code examples (through shell scripts most likely) to help other users.

Milestones

Below is a list of milestones to reach throughout the whole internship. These milestones will help to provide some structure to the internship and help sets some goals.

• First week
  • Merge at least two PRs, both related to the examples. One on the website repository, another one in the vitess repository.
  • These two PRs can be related to minor improvements to the examples.
    • Common issue faced during the setup of the Vitess operator for Kubernetes #1848
    • Change the version #1847
  • You should have a fully functional development environment on both repositories.
  • Expand on the troubleshooting guide, based on your exploration of the getting started guide, report any problem to the troubleshooting page and detail how you went around these problems.
  • When running the getting started guide run both the K8S and Local examples.
  • When running the getting started guide, make sure VTAdmin is running. Explore what VTAdmin is, and try to see how you can incorporate it a bit more to the getting started guide docs. Right now VTAdmin is barely mentioned in the getting started guide.
  • Start the exploration of Vitess, the goal is to go through most of the Vitess features and understand what's missing in the getting started guide and become more familiar with Vitess. Gaps in the docs should be found.
• Second week
  • Continue that exploration.
  • Come up with a list of things of guides that are missing based on the features you explored last and this week.
    • Add VTAdmin section under Concepts: Overview, features, and workflow. #1856
  • Make at least two major additions to the examples that cover additional concepts. Preferably adding new steps after the 30x examples. By the end of the 30x examples, we have a very typical vitess cluster that can cover most of the use cases, we want to build on top of that cluster by adding new guides, e.g. 40x, 50x, 60x, etc. For instance: continue the 40x step to add how to take and restore backups in the local examples, the K8S part already has some content on this. Things like: backups, schema changes, mysql configuration, etc can be covered.
    • Added the initial script for the 40x example for backup and restore  vitess#16893
    • Add a webpage that walks through the new backup and restore examples for a local Vitess environment. #1861
• Third week and beyond
  • Incorporate the list of things we came up with during the second week.
  • 2 major additions / PRs should be contributed each week on average. These additions should be meaningful and long-lasting, the PRs will be reviewed by several maintainers to ensure they fit these criterias.
  • Changes to the troubleshooting guide should be done as soon as a problem is encountered.
• Last week
  • Write a blog post about everything you have done and contributed. This blog post will highlight your work and will be shared with the rest of the community.
  • Participate in November's monthly meeting, where all contributors and users meet and discuss about vitess. In this monthly meeting, you'll be able to share what you worked on and get feedback from the community.

[AayushSaini101]

@frouioui I am interested in this project. I have contributed in asyncapi cli and writing technical writing as well. I have contributed in this documentation: https://www.asyncapi.com/docs/tools/cli/usage and I explored many architecture regarding vitess: https://www.youtube.com/watch?v=q65TleTn2vg&t=1200s and found very interesting. If there are any prerequisite for this project, please let me know, i am happy to contribute thanks :)

[Ayush9026]

@frouioui sir i am also interested in this project i am also contributing to other CNCF projects.

[kairveeehh]

@frouioui hii , I am kairvee and would like to take up this issue under LFX phase 3 , as it perfectlty aligns with my interest and skills

[rahulbansal3005]

Hi @frouioui. I am rahul and i am very interested to work on this issue, in upcoming Term in LFX. I went through the Repo also to get an understanding, if there is any pre-requisite please let me know.

[arunavabasucom]

@frouioui would like to work on this project .

[mhmohona]

Hello @frouioui,I've been reviewing the topics mentioned in the issue discription. I've found some existing documentation, but I'm missing links for a few topics. Could you please clarify the following:

1. I've located these existing documents:

   • Backups
   • VReplication
   • Foreign Keys (FKs)
   • Troubleshooting / Common Issues Guide

2. However, I couldn't find existing documentation for:

   • Managed

3. For clarity on the project scope:

   • For topics with existing documentation (Backups, VReplication, FKs, Troubleshooting), should the mentee rewrite or improve these guides?
   • For topic without existing documentation (Managed Vitess), should the mentee create new "Getting Started" guides from scratch?
   • Is it correct that all new or rewritten guides should include code examples, preferably as shell scripts?

This approach would ensure that we have comprehensive "Getting Started" guides with practical code examples for all specified topics. Could you confirm if this understanding is correct?

[Shruti78]

@frouioui would love to contribute in this project .

[eeshaanSA]

Great research, @mhmohona. As a fellow contributor, I'm also interested in this project and have similar questions. Looking forward for your thoughts and clarifications. @frouioui

[frouioui]

This LFX mentorship is terminated, closing this issue for now.