DEV Community

Vishnu Das Puthukudi
Vishnu Das Puthukudi

Posted on

My First Open Source Journey: Adding a TLDR Page to the tldr project

I decided to Start the path towards creating open-source software with the "TLDR" project, a repository that contains a number of community's-maintained help pages for CLI tools.
I started the investigation when I made the decision to look at the "Good First Issue" Difficulties. I narrowed down my choices till I found one that caught my attention and offered a satisfying challenge.
The issue opened me to a new concept about Azure Kubernetes Service(AKS). The 'AKS' command is the official CLI tool for controlling Azure Kubernetes Service clusters is the subject of the project to developed a 'TLDR' Page.
I have also went into the TLDR community in order to address this enormous problem, looking for advice and assistance. Through the project's Matrix group chat group. I made connection with other contributors, sharing my experience and seeking guidance from others who had already successfully navigated these big projects.
The centerpiece of my contribution was a painstakingly written 'az-aks.md' file that adhered to the exact structure and rules specified in the TLDR manual. In order to help command-line users learn this potent tool, it needed reducing a profusion of 'AKS' command nuances into a succinct collection of usage examples. The procedure was a learning experience like no other. Along with learning about the Azure Kubernetes Service, I also gained knowledge about good documentation and the subtleties of working with open-source communities. I experienced both roadblocks and lightbulb moments along the way, and each helped me become a more knowledgeable advocate for open-source software. It was time for me to submit my masterpiece after all of the hard work. I started a pull request and sent the 'aks.md' file to the TLDR repository, which is available the PULL REQUEST. This moment was unmatched in its thrill and fulfilment. My introduction to the world of open-source contributions began with this. I want to give readers an honest look at the world of open source in this story. I discuss my challenges, insights, and ultimate success in the hopes of motivating other beginners to go off on their own open source experiences.

Qodo Takeover

Introducing Qodo Gen 1.0: Transform Your Workflow with Agentic AI

Rather than just generating snippets, our agents understand your entire project context, can make decisions, use tools, and carry out tasks autonomously.

Read full post →

Top comments (0)

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more

AWS GenAI LIVE!

GenAI LIVE! is a dynamic live-streamed show exploring how AWS and our partners are helping organizations unlock real value with generative AI.

Tune in to the full event

DEV is partnering to bring live events to the community. Join us or dismiss this billboard if you're not interested. ❤️