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.

Sign up for GitHub

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

Jump to bottom

Write docs #1

Closed
mostafa opened this issue Oct 16, 2022 · 3 comments
Closed

Write docs #1

mostafa opened this issue Oct 16, 2022 · 3 comments
Assignees
@mostafa
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mostafa
Copy link
Member

mostafa commented Oct 16, 2022 •
edited
Loading

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:
@mostafa mostafa self-assigned this Oct 16, 2022
@mostafa mostafa added the enhancement New feature or request label Feb 2, 2023
@mostafa
Copy link
Member Author

mostafa commented Feb 23, 2023 •
edited
Loading

Initial ToC of the docs

  • Getting started
    • Welcome
    • Installation
    • Running GatewayD
    • Resources
  • Using GatewayD
    • Configuration
      • Global
      • Plugins
      • Environment variables
      • Runtime configuration
    • CLI
    • Servers
    • Clients
    • Pools
    • Proxies
      • L4 transparent proxy
      • Health check
    • Observability
      • Loggers
      • Metrics
      • Traces
    • API
      • gRPC
      • HTTP
    • Connection lifecycle
    • Protocols
  • Using plugins
    • Plugins
      • Policies
        • Verification
        • Compatibility
        • Acceptance
      • Reload on crash
      • Health check
      • Metrics merger
      • Command-line arguments
      • Environment variables
      • Checksum verification
    • Hooks
      • Types (traffic and notification)
      • Timeout
    • Plugin registry
    • Hook registry
    • Plugin types
      • Built-in plugins
      • Community plugins
      • Enterprise plugins
    • Proposals
  • Developing plugins
    • Plugin lifecycle
    • SDK reference
    • gRPC API reference
    • Template projects (Go and Python)
  • GatewayD versus
    • MaxScale
    • ProxySQL
    • Acra
    • Stargate
    • Heimdall Data
    • Bytebase
    • Airbyte
    • Arana
    • PgBouncer, PgPool-II and pgcat
  • Community
    • Learning
    • Contributing
      • GatewayD public roadmap
      • Plugins public roadmap
      • Public proposals
    • Forum
    • Chat
    • Social accounts
    • Code of conduct
    • Test server
  • Misc
    • Telemetry and usage report
    • Error reporting
    • Release notes
    • Glossary

@mostafa
Copy link
Member Author

mostafa commented Apr 18, 2023

The docs are written. Now they should be published using a static docs generator.

@mostafa mostafa changed the title Create docs Write docs Apr 21, 2023
@mostafa mostafa mentioned this issue Apr 21, 2023
Closed
@mostafa
Copy link
Member Author

mostafa commented Apr 21, 2023

The creation of the docs website will be tracked in #5.

@mostafa mostafa closed this as completed Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mostafa mostafa

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mostafa