Docs: The Great Description-ing#3057
Open
aeluce wants to merge 8 commits into
Open
Conversation
|
🚀 Preview deployed to https://docs.estuary.dev/pr-preview/pr-3057/ 📄 Changed pages: |
Collaborator
Author
|
@jwhartley could this get merged/incorporated before estuary/connectors#4528 or should I plan to redo the connector meta descriptions after the move? |
Contributor
|
Yes we can land it now, I’ll reconcile all the changes that have happened
before cutover.
…On Wed, 1 Jul 2026 at 12:41 am, aeluce ***@***.***> wrote:
*aeluce* left a comment (estuary/flow#3057)
<#3057 (comment)>
@jwhartley <https://github.com/jwhartley> could this get
merged/incorporated before estuary/connectors#4528
<estuary/connectors#4528> or should I plan to
redo the connector meta descriptions after the move?
—
Reply to this email directly, view it on GitHub
<#3057?email_source=notifications&email_token=ADTE7HPWXRUC53UNNCBTAFD5CPGTJA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOBUGQ3DSNZVG432M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#issuecomment-4844697577>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ADTE7HIUFIWR22HOJS4NAH35CPGTJAVCNFSNUABFKJSXA33TNF2G64TZHMZDIMBRG4ZTKOJWHNEXG43VMU5TINRZGQZTINJRHE22C5QC>
.
Triage notifications, keep track of coding agent tasks and review pull
requests on the go with GitHub Mobile for iOS
<https://github.com/notifications/mobile/ios/ADTE7HPIRS2OVK5MTQFOSQT5CPGTJA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOBUGQ3DSNZVG432M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJKTGN5XXIZLSL5UW64Y>
and Android
<https://github.com/notifications/mobile/android/ADTE7HPRKUDGWZUNQO2RKVL5CPGTJA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIOBUGQ3DSNZVG432M4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLTGN5XXIZLSL5QW4ZDSN5UWI>.
Download it today!
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
Most of our docs pages lack explicit meta descriptions. This can cause some odd behavior with default descriptions, which pull from the first line of the page body. This first line isn't necessarily a good summary of the page and often is cut off (one page, notably, ends up with a meta description that's simply "Problem"), leading to poor search engine and social preview experiences.
This PR adds and updates explicit meta descriptions on most docs pages and adjusts a few page titles. It also modifies the post-build script that updates connector meta titles to:
With updates across so many files, I broke out commits into batches. To review certain changes, like the post-build script updates, it may be easier to view by commit.
Documentation links affected:
Almost all.
Notes for reviewers:
Thanks for reviewing! CC @SourabhEstuary I did adjust some of the language you suggested.