gatewayd-io / docs Goto Github PK

Ref: https://github.com/gatewayd-io/docs (ToC)

• https://docusaurus.io/
• https://dev.to/martinadamsdev/how-to-use-docusaurus-in-nextjs-projects-4kei

Tasks

• Build docs in GitHub Actions
• Push build assets to AWS S3 or GitHub Pages repository

Related: #1.

Would be useful to understand how gatewayD behaves compared to various runtime modes of pgBouncer. Are there any impacts to transactionality, prepared statements etc?

It would also be useful to indicate some supported/recommended configurations in terms of concurrent connection capacity/pooling across standard AWS/GCP/Azure VM sizes.

https://github.com/jekyll/jekyll-seo-tag

https://github.com/jekyll/github-metadata

This could be done as part of the strapi+gatsby setup with the new typeName I added to the Articles model, so that we have a unified website, docs and blog.

Resources:

• https://mintlify.com/
• https://getdoks.org/
• https://docsify.js.org/
• https://strapi.io/
• https://rocketdocs.gatsbyjs.io/
• https://gatsbytemplates.io/
• https://jamtemplates.com/templates/smooth-doc
• https://www.gatsbyjs.com/starters/hasura/gatsby-gitbook-starter (?)
• https://docusaurus.io/
• https://www.docz.site/
  • https://www.gatsbyjs.com/tutorial/writing-documentation-with-docz/

Ref: https://github.com/gatewayd-io/docs (ToC)

• https://github.com/gatewayd-io/docs/blob/main/_includes/nav_footer_custom.html
• https://medium.com/@derekkedziora/how-to-add-a-dark-mode-toggle-to-a-jekyll-site-a76dac00128d
• https://randomwits.com/blog/dark-mode-jekyll

The current guide needs a revamp and must either be converted to a tutorial, or be paired with one in the blog.

The env-var structure is changed after the introduction of config blocks. This should be updated to reflect those as well. The issue #583 must be fixed before updating the docs.

Related

• gatewayd-io/gatewayd#398
• gatewayd-io/gatewayd#577
• gatewayd-io/gatewayd#583
• #61

• DevEnv setup, linting, make targets, go modules, etc.
• Package structure and components
• Configuration (global and plugins)
• Observability (logs, metrics and traces)
• Protobuf, gRPC and buf
• Schedulers
• Release process (test -> tag -> release)
• SDK and plugin development (plugin template, metrics merger, health check, etc.)

When users install using Homebrew, it's only one-step.
The install can occur on any folder because all formulas are placed in /usr/local/bin
so no changes to .bash_profile PATH is needed.
It also enables users to upgrade all formulae with one command.
It's free! See https://docs.brew.sh/Formula-Cookbook

https://github.com/jekyll/jekyll-sitemap

Related to #9.