Skip to content

Commit

Permalink
Update README.md, add and fix links in PGD docs
Browse files Browse the repository at this point in the history
Minor improvements  to `README.md`.
Add link to the OpenTelemetry project in the OpenTelemetry chapter.
Fix broken links in the Monitoring through SQL chapter.

Signed-off-by: Lenz Grimmer <[email protected]>
  • Loading branch information
Lenz Grimmer authored and djw-m committed Aug 23, 2023
1 parent 3403215 commit 5a03d53
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ At this point you have a couple options.

1. Run `npm run start`. The application will start in the background and take a few minutes to load.

1. You can view logs and monitor the startup process by running `npm run logs`. Once it's finished it can be accessed at `http://localhost:8000/`.
1. You can view logs and monitor the startup process by running `npm run logs`. Once it's finished it can be accessed at [http://localhost:8000/](http://localhost:8000).

#### Additional Commands and Options for the Docker Environment

Expand All @@ -63,7 +63,7 @@ At this point you have a couple options.

If you find that the container crashes frequently or see that your container has exited with code 137, increasing the Docker memory should help. Allocating at least 4GB is recommended.

1. open Docker Desktop
1. Open Docker Desktop

1. Go to Preferences (gear icon in the top right corner)

Expand Down Expand Up @@ -283,7 +283,7 @@ If you need to setup a redirect from Docs 1.0 to Docs 2.0 manually, this is the

# MDX Format

Documentation must be formatted as an [MDX file](https://www.gatsbyjs.com/docs/mdx/writing-pages/) with the `.mdx` extension. MDX is a superset of [Markdown](https://www.markdownguide.org/).
Documentation must be formatted as an [MDX file](https://www.gatsbyjs.com/docs/how-to/routing/mdx/) with the `.mdx` extension. MDX is a superset of [Markdown](https://www.markdownguide.org/). See [What is MDX?](https://mdxjs.com/docs/what-is-mdx/) for a detailed explanation of the format.

## Frontmatter

Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/5/monitoring/otel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: OpenTelemetry integration
---

You can configure EDB Postgres Distributed to report monitoring information
as well as traces to the OpenTelemetry collector.
as well as traces to the [OpenTelemetry](https://opentelemetry.io/) collector.

EDB Postgres Distributed OTEL collector fills several resource attributes.
These are attached to all metrics and traces:
Expand Down
4 changes: 2 additions & 2 deletions product_docs/docs/pgd/5/monitoring/sql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ You can use another view for monitoring of outgoing replication activity:

- [`bdr.node_replication_rates`](/pgd/latest/reference/catalogs-visible/#bdrnode_replication_rates) for monitoring outgoing replication

The []`bdr.node_replication_rates`](/pgd/latest/reference/catalogs-visible/#bdrnode_replication_rates) view gives an overall picture of the outgoing
The [`bdr.node_replication_rates`](/pgd/latest/reference/catalogs-visible/#bdrnode_replication_rates) view gives an overall picture of the outgoing
replication activity along with the catchup estimates for peer nodes,
specifically.

Expand Down Expand Up @@ -152,7 +152,7 @@ view.
!!! Note
This catalog is present only when the bdr-enterprise extension is installed.

Administrators can query `[`bdr.node_slots`](/pgd/latest/reference/catalogs-visible/#bdrnode_slots) for outgoing replication from the
Administrators can query [`bdr.node_slots`](/pgd/latest/reference/catalogs-visible/#bdrnode_slots) for outgoing replication from the
local node. It shows information about replication status of all other nodes
in the group that are known to the current node as well as any additional
replication slots created by PGD on the current node.
Expand Down

1 comment on commit 5a03d53

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

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

Please sign in to comment.