Skip to content

Commit

Permalink
Update links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mostafa committed Jul 31, 2023
1 parent e044e77 commit 08af9a0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<p align="center">
<a href="https://github.com/gatewayd-io/gatewayd/releases">Download</a> ·
<a href="https://gatewayd.io/docs">Documentation</a>
<a href="https://docs.gatewayd.io">Documentation</a>
</p>

**GatewayD** is a free and open-source cloud-native database gateway and framework for building data-driven applications. It sits between your database servers and clients and proxies all their communication. It is like API gateways, for databases.
Expand Down Expand Up @@ -64,14 +64,14 @@ The plugins are *usually* written in Go and are compiled into stand-alone execut

The docs cover all aspects of using GatewayD. Some highlights include:

- [Getting Started](https://gatewayd.io/docs): install, run an instance of GatewayD and test it in action.
- [Configuration](https://gatewayd.io/docs/using-gatewayd/configuration): learn how you can configure GatewayD to behave as you like.
- [Global Configuration](https://gatewayd.io/docs/using-gatewayd/configuration#global-configuration): control GatewayD's behavior.
- [Plugins Configuration](https://gatewayd.io/docs/using-gatewayd/configuration#plugins-configuration): control GatewayD's plugin registry and the plugins' behavior.
- [Observability](https://gatewayd.io/docs/using-gatewayd/observability): logs, metrics, and traces are GatewayD's first-class citizens.
- [Using Plugins](https://gatewayd.io/docs/using-plugins/plugins): learn how to use plugins.
- [Developing Plugins](https://gatewayd.io/docs/developing-plugins/plugin-developers-guide): learn how to develop your own plugins.
- [gatewayd-plugin-cache](https://gatewayd.io/docs/plugins/gatewayd-plugin-cache): learn how to use the `gatewayd-plugin-cache` plugin for caching queries and their results.
- [Getting Started](https://docs.gatewayd.io): install, run an instance of GatewayD and test it in action.
- [Configuration](https://docs.gatewayd.io/using-gatewayd/configuration): learn how you can configure GatewayD to behave as you like.
- [Global Configuration](https://docs.gatewayd.io/using-gatewayd/configuration#global-configuration): control GatewayD's behavior.
- [Plugins Configuration](https://docs.gatewayd.io/using-gatewayd/configuration#plugins-configuration): control GatewayD's plugin registry and the plugins' behavior.
- [Observability](https://docs.gatewayd.io/using-gatewayd/observability): logs, metrics, and traces are GatewayD's first-class citizens.
- [Using Plugins](https://docs.gatewayd.io/using-plugins/plugins): learn how to use plugins.
- [Developing Plugins](https://docs.gatewayd.io/developing-plugins/plugin-developers-guide): learn how to develop your own plugins.
- [gatewayd-plugin-cache](https://docs.gatewayd.io/plugins/gatewayd-plugin-cache): learn how to use the `gatewayd-plugin-cache` plugin for caching queries and their results.

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ services:
command: ["run"]
environment:
# For more information about the environment variables, see:
# https://gatewayd.io/docs/using-gatewayd/configuration#environment-variables
# https://docs.gatewayd.io/using-gatewayd/configuration#environment-variables
- GATEWAYD_CLIENTS_DEFAULT_ADDRESS=postgres:5432
# - GATEWAYD_LOGGERS_DEFAULT_LEVEL=debug
ports:
Expand Down

0 comments on commit 08af9a0

Please sign in to comment.