Skip to content

workers: new Databases sidebar section#8914

Merged
elithrar merged 17 commits into
productionfrom
silverlock/database-beta-docs
May 16, 2023
Merged

workers: new Databases sidebar section#8914
elithrar merged 17 commits into
productionfrom
silverlock/database-beta-docs

Conversation

@elithrar

@elithrar elithrar commented May 15, 2023

Copy link
Copy Markdown
Collaborator

Ready to go 🏁

  • Add a new "Databases" (/workers/databases/) top-level sidebar navigation to improve how users discover options for database connectivity to Workers
  • Add new Connecting to Databases page as a hub for HTTP/serverless drivers, the Socket API, and the new integrations (workers: add native database integrations tutorials #8887)
  • Document how to connect to PostgreSQL using the pg driver, including caveats
  • Add a cross-link to the D1 documentation.

Updated navigation:

image

@elithrar elithrar added the product:workers Related to Workers product label May 15, 2023
@elithrar
elithrar requested a review from deadlypants1973 May 15, 2023 19:53
@elithrar elithrar self-assigned this May 15, 2023
@gitguardian

gitguardian Bot commented May 15, 2023

Copy link
Copy Markdown

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
Once a secret has been leaked into a git repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented May 15, 2023

Copy link
Copy Markdown

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 362a930
Status: ✅  Deploy successful!
Preview URL: https://260d6bdc.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://silverlock-database-beta-doc.cloudflare-docs-7ou.pages.dev

View logs

@elithrar
elithrar force-pushed the silverlock/database-beta-docs branch from d8c9e83 to 98c62c4 Compare May 15, 2023 20:00

@irvinebroque irvinebroque left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changed the URL for sockets docs from /runtime-apis/connect to /runtime-apis/tcp-sockets (see suggested edits)

Comment thread content/workers/databases/connect-to-postgres.md Outdated
Comment thread content/workers/databases/connect-to-postgres.md Outdated
Comment thread content/workers/databases/connect-to-postgres.md Outdated
Comment thread content/workers/databases/connect-to-postgres.md
elithrar and others added 2 commits May 15, 2023 19:36
Co-authored-by: Brendan Irvine-Broque <birvine-broque@cloudflare.com>
@elithrar
elithrar marked this pull request as ready for review May 16, 2023 00:51
@elithrar

Copy link
Copy Markdown
Collaborator Author

Note: The GitGuardian check is a false positive.

Comment thread content/workers/databases/connecting-to-databases.md Outdated
@elithrar
elithrar force-pushed the silverlock/database-beta-docs branch from da2ea20 to 0e992e6 Compare May 16, 2023 02:44

@irvinebroque irvinebroque left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🚀

@dom96 dom96 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Super awesome!

Comment thread content/workers/platform/changelog.md Outdated
Comment thread connect-to-postgres.md Outdated
@elithrar

Copy link
Copy Markdown
Collaborator Author

The checks are failing on broken links until #8795 is merged.

Comment thread content/workers/databases/connecting-to-databases.md Outdated
Comment thread content/workers/databases/connecting-to-databases.md Outdated
Comment thread content/workers/databases/connect-to-postgres.md Outdated
Comment thread content/workers/databases/connect-to-postgres.md Outdated
Comment thread content/workers/databases/connect-to-postgres.md Outdated
Comment thread content/workers/databases/connecting-to-databases.md Outdated
Comment thread content/workers/databases/connecting-to-databases.md Outdated
Comment thread content/workers/databases/connecting-to-databases.md Outdated
Comment thread content/workers/databases/connecting-to-databases.md Outdated
Comment thread content/workers/databases/connecting-to-databases.md Outdated
elithrar and others added 3 commits May 16, 2023 07:39
Co-authored-by: Kate Tungusova <70746074+deadlypants1973@users.noreply.github.com>
Co-authored-by: Kate Tungusova <70746074+deadlypants1973@users.noreply.github.com>
irvinebroque and others added 2 commits May 16, 2023 08:21
* add /runtime-apis/connect

* Add note about global scope

* Add error handling section

* Add section about closing sockets with examples of allowHalfOpen

* Fix example, add note about --experimental-local

* Apply suggestions from code review

Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com>

* Apply suggestions from code review

Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com>

* Remove expectedHostname

* Clarify connection between connect() and max open connections

* Fix broken link

* Move StartTlS considerations up to StartTLS section

* Fix error handling code block

* Formatting, intro sentence to error handling example

* Clarify that existing readers/writers cannot be reused after .startTls()

* Rename page from connect to tcp-sockets

* Add /protocols page

* Edits to /protocols

* /runtime-apis/connect -> /runtime-apis/tcp-sockets

* Fix broken URL

* workers: Apply suggestions from code review

Co-authored-by: Kate Tungusova <70746074+deadlypants1973@users.noreply.github.com>
Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com>

---------

Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com>
Co-authored-by: Matt Silverlock <msilverlock@cloudflare.com>
Co-authored-by: Kate Tungusova <70746074+deadlypants1973@users.noreply.github.com>
@elithrar

Copy link
Copy Markdown
Collaborator Author

Rebased after merging #8795

@elithrar

Copy link
Copy Markdown
Collaborator Author

PR got hosed. Fixing...

@elithrar
elithrar marked this pull request as draft May 16, 2023 12:28
@elithrar
elithrar marked this pull request as ready for review May 16, 2023 12:33
@elithrar
elithrar merged commit fff9c9c into production May 16, 2023
@elithrar
elithrar deleted the silverlock/database-beta-docs branch May 16, 2023 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants