Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

11222 update docs contributor guide #50974

Merged
merged 6 commits into from
Jan 8, 2025

Conversation

ian-at-airbyte
Copy link
Contributor

What

Resolves #11222. Updates the documentation contributor guide. This change refreshes the presentation and organization of the content, adds new open source topic templates, adds new guidance for product badges, AI usage, and diagrams, and removes/addresses various statements that ceased to be correct at some point in the past.

How

Updates three existing topics with new information.

Review guide

This probably only needs a cursory review to approve. It's pretty straightforward and doesn't introduce a ton of new information.

User Impact

Airbyte employees and contributors from the community should find it a bit easier to onboard onto writing docs. This is especially important as I try to build a small network of OSS docs contributors.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Jan 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 10:09pm

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jan 8, 2025
Copy link
Contributor

@nataliekwong nataliekwong left a comment

Choose a reason for hiding this comment

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

This is so much more readable and easy to understand!

docs/contributing-to-airbyte/writing-docs.md Outdated Show resolved Hide resolved
@ian-at-airbyte ian-at-airbyte enabled auto-merge (squash) January 8, 2025 21:59
@ian-at-airbyte ian-at-airbyte merged commit 337597f into master Jan 8, 2025
26 checks passed
@ian-at-airbyte ian-at-airbyte deleted the 11222-update-docs-contributor-guide branch January 8, 2025 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants