Skip to content

docs: update docs links to point to docs.pgedge.com #220

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

Merged
mmols merged 3 commits into from
Dec 11, 2025
Merged

docs: update docs links to point to docs.pgedge.com #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97c70dc
docs: update docs links to point to docs.pgedge.com
mmols Dec 11, 2025
b3f505f
docs: update features list in README
mmols Dec 11, 2025
942f1ec
update NOTICE.txt
mmols Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion NOTICE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10428,7 +10428,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

* Name: go.etcd.io/etcd/client/v3
* Version: v3.6.5
* License: [Apache-2.0](https://github.com/etcd-io/etcd/blob/client/v3.6.5/client/LICENSE)
* License: [Apache-2.0](https://github.com/etcd-io/etcd/blob/client/v3.6.5/client/v3/LICENSE)

```

Expand Down
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ You interact with the Control Plane via an HTTP API. Once you've initialized a C
- [Releases](#releases)
- [Development](#development)
- [Documentation](#documentation)
- [Quick Start](docs/quickstart.md)
- [Concepts](docs/concepts.md)
- [Installation](docs/installation.md)
- [Configuration](docs/configuration.md)
- [Quick Start](https://docs.pgedge.com/control-plane/installation/quickstart/)
- [Concepts](https://docs.pgedge.com/control-plane/prerequisites/concepts/)
- [Installation](https://docs.pgedge.com/control-plane/installation/installation/)
- [Configuration](https://docs.pgedge.com/control-plane/installation/configuration/)

## Features

Expand All @@ -39,6 +39,7 @@ At a high level, the pgEdge Control Plane supports:
- monitoring database operations through detailed task logs, enabling visibility into deployment progress, troubleshooting, and historical activity tracking.
- secure API access with certificate-based authentication.
- performing in-place minor version upgrades of Postgres and supporting components.
- performing major version upgrades of Postgres using zero downtime node addition.

## Releases

Expand Down Expand Up @@ -84,10 +85,12 @@ For step-by-step guidance on using this setup, including interacting with the AP

This project includes a documentation site maintained in the [docs](docs/) folder, which covers usage guides, architecture concepts, installation instructions, configuration options, and development workflows.

You can view the latest version of the documentation at [docs.pgedge.com/control-plane](https://docs.pgedge.com/control-plane/)

It uses MkDocs with the Material theme to generate styled static HTML documentation from Markdown files in the docs directory.

The documentation can be accessed locally at http://localhost:8000 using:

``` sh
make docs
```
```