feat: add automated documentation sync reminders and template improve…

[jstirnaman]

…ments

• Add GitHub Actions workflow to detect README changes and create sync reminders
• Update README_TEMPLATE.md with documentation sync instructions
• Add validate_readme.py script for template compliance checking
• Update CONTRIBUTING.md with comprehensive documentation sync process guide

The workflow automatically:

• Detects plugin README changes on master branch commits
• Creates commit comments with pre-filled sync request links to docs-v2
• Provides clear instructions for the sync process
• Requires no secrets or cross-repository authentication

Updated documentation includes:

• Complete sync workflow instructions
• Template compliance requirements
• Automated sync process explanation
• Manual sync alternatives

This workflow works with influxdata/docs-v2#6329 to sync updated READMEs in influxdb3_plugins to influxdata/docs-v2.

[Copilot]

Pull Request Overview

This PR adds an automated documentation sync system to remind contributors to synchronize plugin README changes with the InfluxDB documentation site. The workflow automatically detects when plugin READMEs are modified and provides clear instructions for syncing those changes to the docs-v2 repository.

Key changes:

• Automated detection and reminder system for README changes via GitHub Actions
• Comprehensive README template with sync instructions and validation requirements
• Python validation script to ensure README compliance with template standards

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
.github/workflows/remind-sync-docs.yml	GitHub Actions workflow that detects README changes and creates sync reminder comments
README_TEMPLATE.md	Comprehensive template for plugin READMEs with sync instructions and proper structure
CONTRIBUTING.md	Updated with detailed documentation sync process and requirements
scripts/validate_readme.py	Python script for validating README compliance against template standards

Comments suppressed due to low confidence (1)

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

[MeelahMe]

So far I have:

• Changed workflow now triggers on 'main' branch instead of 'master' that appeared to be causing an error
• Updated .github/workflows/remind-sync-docs.yml
• Improved validation script flexibility
• Fixed basic_transformation README structure
• Tested locally and confirmed the workflow detection logic works

[Copilot]

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

[MeelahMe]

@jstirnaman

Updates Summary

Here's what I did:

Main Fix

• Fixed the workflow to trigger on main branch instead of master - this looked to be the reason for the error. Workflow was not triggering in master.

Improvements

• Cleaned up the validation script - reduced false positive errors from 7+ down to 0. The script now accurately validates plugin READMEs.
• Addressed Copilot feedback - removed the 10-file limit (so we won't miss changes if lots of plugins are updated) and moved some hardcoded values to constants for easier maintenance.

Testing

Tested locally:

• Workflow detection logic correctly identifies changed READMEs
• Validation script passes with 0 errors on test plugins
• All code quality checks passing

Status: Ready for review