01 Aug TWT Mentoring Workshop: Version Control and Static Site Generation with Docs as Code
As part of TWT Mentorship program, TWT NCR is introducing a Workshop to help you learn version control and static site generation with Docs as code.
Divided into two sessions, the program is designed to help you learn how to apply Docs-as-code process using Jekyll, the static site generator. During the course, you will also learn how to use GitHub and get familiar with version control.
At the end of the course, you will have good learning to use Git, GitHub and work with Jekyll to manage doc websites.
Our first Mentorship Program (Mastering Job Search) was concluded in June, 2023.
- Type of Activity: TWT Mentoring for tech writers
- Duration: 2 Sessions, 5 hours
- Dates: Aug 12 and 19, 2023
- Time: 10 AM-12.30 PM IST
- INR 400 from our website using UPI payment
- INR 325 from Tech Writer’s Tribe App
- USD 25 for participants from outside India
- Level: Beginners and intermediate
- Our USP: Highly Interactive virtual sessions
- Practice-based sessions
- Creating projects during the course
- Recordings of sessions available till September 19 for future reference (TWT Annual Members can access for 6 months)
- Participation Certificate
Who should attend?
- Those who want to learn Git and GitHub
- Those who want to implement Docs-as-code Process to replace conventional modes of Technical documentation process.
- Leaders or decision makers who want to reduce cost to company and improve technical documentation websites.
- Documentation teams members who want to control the whole process from writing Guides to maintaining the documentation website.
- Those who want to use GitHub for Technical documentation projects.
Part 1: Introduction
- Welcome and workshop overview
- Icebreaker activity to gauge participants’ familiarity with version control and web development concepts
Part 2: Understanding Version Control with Git
- What is version control?
- Why use version control in software development and web projects?
- Introducing Git: History and purpose
- Basic Git concepts:
Part 3: Git Basics
- Installing Git on different platforms
- Configuring Git with user information
- Initializing a Git repository
- Creating commits and understanding commit messages
- Checking the status of a repository
- Using Git’s staging area (git add)
- Creating branches and switching between them
Part 4: Collaborating with Git and GitHub
- Introduction to GitHub and its role in collaboration
- Creating a GitHub account
- Linking a local Git repository to a remote GitHub repository
- Pushing changes to a remote repository
- Pulling changes from a remote repository
- Handling merge conflicts
Part 5: Intermediate Git Concepts
- Understanding advanced branching strategies (For example, feature branches, release branches)
- Working with remote branches and tracking branches
- Rebasing vs. merging
- Using Git tags for releases
Part 6: Introduction to Jekyll
- What is Jekyll, and why use it for web development?
- Jekyll’s static site generation process
- Setting up Jekyll on a local development environment
Part 7: Creating a Simple Jekyll Website
- Understanding the Jekyll directory structure
- Creating and organizing content in Jekyll
- Working with templates and layouts
- Adding and customizing themes in Jekyll
Part 8: Adding Functionality with Plugins and Extensions
- Exploring Jekyll plugins
- Installing and configuring plugins to enhance your website
Part 9: Deploying a Jekyll Website
- Preparing the website for deployment
- Deploying the website on GitHub Pages
- Deploying the website on other hosting platforms
Part 10: Bonus Topics (Time Permitting)
- Working with data files in Jekyll
- Customizing the Jekyll build process
- Optimizing Jekyll websites for performance
Part 11: Recap and Q&A
- Summarize key concepts from the workshop
- Open the floor to questions and provide answers
Part 12: Hands-on Practice and Exercises
- Provide participants with a practical exercise or a mini-project to apply what they’ve learned during the workshop
- Sharing Participation Certificate
About the Trainer: Gaurav Trivedi
Current Role: Senior Technical Writer, Red Hat (NCR)
In his words..
I’m an avid writer who loves to read, converse, and connect. Currently working at Red Hat, I’m loving my career in this interesting and versatile profile. I’ve always been a person who thrives to learn, gain experience, and sincere at whatever I do. I’ve been using Antora for over five years. I’m currently using it daily to document many of projects at Red Hat, my current organization.
Follow me on LinkedIn
REGISTRATION IS CLOSED. Write an email to firstname.lastname@example.org if you want to join the next workshop.
Join the Community on Tech Writer’s Tribe App
Download on mobile
Android Users can download Tech Writer’s Tribe from Play Store app.
CLICK FROM MOBILE to download.
Access from Browser on Laptop/Desktop
The users of iOS can access it from the web browser.
Click here to open it in any browser
(DO NOT CLICK LINK FROM MOBILE)
The iOS version of the app will be available in a few weeks.