Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: "Updating CloudNativePG's documentation"
date: 2026-01-12
draft: false
image:
url: anushka-saxena.jpg
attribution:
authors:
- fdrees
tags:
- mentorship
- lfx
- cncf
- PostgreSQL
- Kubernetes
- documentation
- docusaurus
summary: "Meet the mentee: Anushka Saxena worked with the project maintainers on transforming
the documentation for CloudNativePG, as part of the LFX mentorship program."
---

In the summer we wrote about how CloudNativePG was back for the September-
October-November LFX term with [several projects for mentoring](https://cloudnative-pg.io/blog/2025-term3-lfx-cncf-mentorship/). One of them was around the Docs.
Copy link
Contributor

Choose a reason for hiding this comment

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

"projects for mentoring" I think can be misread.
Maybe we could rephrase to "... CloudNativePG was back for the September-October-November term of LFX Mentorship with several projects.


[Anushka Saxena](https://www.linkedin.com/in/-anushka-saxena/) is a Software Application Development Apprentice at Google, and is based in Bengaluru, India. She worked on improving the project’s documentation automation and multi-version support with mentors and CloudNativePG maintainers Gabriele Bartolini, Leonardo Cecchi, and Francesco Canovai.

I had a chat with Anushka about her work, and about how she got into Tech in the first place.

## Start at the beginning

Anushka has always been motivated by curiosity and the desire to understand how systems work. "Over time, open source became a natural extension of that curiosity because it offered a way to learn by contributing, asking questions, and building things that real people use." What really drew her in was when she realized that great software often faces issues not because of poor engineering, but because it’s hard to understand or adopt. "That realization shaped my interest in documentation modernization and contributor experience as first-class technical problems."
Copy link
Contributor

@jsilvela jsilvela Jan 9, 2026

Choose a reason for hiding this comment

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

Meta-comment: because of no line breaks, my comment on the last line of this paragraph seems to apply to the whole paragraph :/

Suggested change
Anushka has always been motivated by curiosity and the desire to understand how systems work. "Over time, open source became a natural extension of that curiosity because it offered a way to learn by contributing, asking questions, and building things that real people use." What really drew her in was when she realized that great software often faces issues not because of poor engineering, but because it’s hard to understand or adopt. "That realization shaped my interest in documentation modernization and contributor experience as first-class technical problems."
Anushka has always been motivated by curiosity and the desire to understand how systems work. "Over time, open source became a natural extension of that curiosity because it offered a way to learn by contributing, asking questions, and building things that real people use." What really drew her in was when she realized that great software often faces issues not because of poor engineering, but because it’s hard to understand or adopt. "That realization shaped my interest in documentation and contributor experience as first-class technical problems."

The way it's written, "document modernization and contributor ..." would need a comma before "and" to help parsing.
But I also think "modernization" is not "a first-class problem". Documentation is.


Anushka is a contributor to the Cloud Native ecosystem, with a particular focus on developer-centric projects where infrastructure, documentation, and community intersect. With a background in community leadership for major cloud providers, she remains active in CNCF initiatives, open-source projects like AsyncAPI, and the broader Developer tooling landscape.

"One community that’s especially close to my heart is Data on Kubernetes (DoK). I first got involved during my college days as a volunteer for DoK Community Days, which was my introduction to cloud-native data workloads and open-source communities by Bart Farell, a mentor and a very well-known personality in the CNCF space. Coming back to the CloudNativePG ecosystem as a mentee later on felt like a full-circle moment!"
Copy link
Member

Choose a reason for hiding this comment

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

Probably worth a link to his linkedin?

Copy link
Contributor

Choose a reason for hiding this comment

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

IMO only the interviewed person's Linkedin profile should be linked in posts.
But if Bart has a personal site, a CNCF profile page or some such, that would be fair to link.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"One community that’s especially close to my heart is Data on Kubernetes (DoK). I first got involved during my college days as a volunteer for DoK Community Days, which was my introduction to cloud-native data workloads and open-source communities by Bart Farell, a mentor and a very well-known personality in the CNCF space. Coming back to the CloudNativePG ecosystem as a mentee later on felt like a full-circle moment!"
"One community that’s especially close to my heart is Data on Kubernetes (DoK). I first got involved during my college days as a volunteer for DoK Community Days, which was my introduction to cloud-native data workloads and open-source communities by [Bart Farell](uhttps://www.linkedin.com/in/bart-farrell/), a mentor and a very well-known personality in the CNCF space. Coming back to the CloudNativePG ecosystem as a mentee later on felt like a full-circle moment!"


## Docs contributions

Anushka worked on automating the import of versioned documentation into the CloudNativePG docs site so that new operator releases automatically trigger the correct documentation build. It started with a major "housekeeping" task: she wrote and executed a series of Node.js utility scripts to sanitize over 60 Markdown files. This involved converting MkDocs-style admonitions to Docusaurus syntax and fixing MDX spacing issues to ensure the build wouldn't crash.

She also worked on the Sidebar Position Multiplier, [a script](https://github.com/cloudnative-pg/docs/pull/22) that intelligently re-indexed our documentation pages (10, 20, 30...) to allow future contributors to insert new pages without breaking the order. Finally, she helped architect the [Auto-Sync Pipeline](https://github.com/cloudnative-pg/docs/pull/18), a GitHub Action that automatically pulls documentation from the main repo into the docs repo whenever a new release is published. This involved writing a reusable import script, integrating it into a GitHub Actions workflow triggered by upstream releases, and validating the output in a Docusaurus-based documentation setup.
Copy link
Member

Choose a reason for hiding this comment

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

The PR cloudnative-pg/docs#22 is closed and has nothing like a script, just a change in some links and a config :S

Copy link
Member

Choose a reason for hiding this comment

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

The PR cloudnative-pg/docs#18 it's a rename of from dev to devel not a pipeline


"A key part of my approach was treating documentation as production infrastructure: iterating locally, validating assumptions, opening pull requests, and refining solutions based on maintainer feedback. The goal was not just to make things work once, but to reduce long-term manual effort and make the documentation workflow more contributor-friendly and reliable."
Copy link
Contributor

Choose a reason for hiding this comment

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

The second part of this paragraph "The goal ..." really needs some commas to help digest the ands.


Anushka says that working with mentors Gabriele, Francesco, and Leonardo was the highlight of her mentorship. "We had a very collaborative rhythm!" Through Slack, GitHub issues, weekly sync calls and pull requests, the team was responsive and generous with feedback, making it easy to iterate and improve. Anushka appreciated that discussions were clear, constructive, and focused on long-term project health rather than quick fixes. "Gabriele, Francesco, and Leonardo constantly provided the overall high-level vision that helped me see how my small scripts would affect the project as a whole."

Seeing my contributions become part of CloudNativePG’s documentation workflow and knowing they would support future releases, is very rewarding. The trust the maintainers placed in me by always encouraging me to take ownership of increasingly complex pieces of the docs pipeline rather than limiting my scope as “just a mentee”, really made me feel included."
Copy link
Contributor

Choose a reason for hiding this comment

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

This paragraph is complex and has a crammed feeling. Some ideas.

Suggested change
Seeing my contributions become part of CloudNativePG’s documentation workflow and knowing they would support future releases, is very rewarding. The trust the maintainers placed in me by always encouraging me to take ownership of increasingly complex pieces of the docs pipeline rather than limiting my scope as “just a mentee”, really made me feel included."
Seeing my contributions become part of CloudNativePG’s documentation workflow, and knowing they would support future releases, is very rewarding. The trust the maintainers placed in me, and their encouragement to take ownership of complex pieces of the pipeline, really made me feel included; not "just a mentee."


## What’s next

While debugging the MDX sanitization, Anushka realized that Docusaurus is much stricter than standard Markdown. A failed build because of a single unclosed `<td>` tag taught her about how modern documentation engines render content as React components, and changed how she now views "docs as code". "Also, realizing how deeply documentation is tied to release engineering made me ponder upon how docs aren’t just reference material, but a critical part of user trust, operational safety, and adoption, especially for something as production-critical as Kubernetes-native PostgreSQL!" Certainly something she'll be taking into her next projects.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a "lessons learned" paragraph, and I think like the previous one, it feels a bit crammed. IMO should be condensed. I like the unclosed td anecdote.


Anushka is keen to stay involved in the project, particularly around documentation tooling, automation, and contributor experience. She's excited to continue working at the intersection of Kubernetes, databases, and community-driven development. "My next big goal is to refine the SEO and AI grounding for the site by making sure that when people ask an AI for CloudNativePG help, they get the most accurate, up-to-date documentation."
Loading