Skip to content

DOCS-README.md-Updates#58

Open
Andriciuc wants to merge 8 commits intomainfrom
docs-update-initial
Open

DOCS-README.md-Updates#58
Andriciuc wants to merge 8 commits intomainfrom
docs-update-initial

Conversation

@Andriciuc
Copy link
Copy Markdown
Collaborator

@Andriciuc Andriciuc commented May 6, 2025

Initial README draft + commit

starting PR draft for pg_gather docs
@Andriciuc Andriciuc self-assigned this May 6, 2025
@Andriciuc Andriciuc added the documentation Improvements or additions to documentation label May 6, 2025
Andriciuc added 6 commits May 12, 2025 19:48
Updated intro and a bit of the highlights
small text fixes
more formatting and improved descripts
more improvements to the titles of the features and describtions of what pg_gather can do for the user
added images to image folder
cleaned and finished for now
@Andriciuc Andriciuc changed the title initial commit DOCS-README.md-Updates May 15, 2025
@Andriciuc Andriciuc marked this pull request as ready for review May 15, 2025 07:21
@Andriciuc Andriciuc requested a review from jobinau May 15, 2025 07:21
@Andriciuc
Copy link
Copy Markdown
Collaborator Author

Hello @jobinau!

I updated the readme for better flow/info presentation, let me know if you have any comments/review requests!

Copy link
Copy Markdown
Owner

@jobinau jobinau left a comment

Choose a reason for hiding this comment

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

There are factual problems
For example, Regarding the line:

`pg_gather` is an extension designed to collect and analyze test results from PostgreSQL test runs, it is especially useful for:

pg_gather is an NOT an extension. But standalone SQL scripts/tooling.
It is the main tooling we use in Percona support for analyzing customer systems.
The main purpose is is to analyze real production workloads, configuration and performance data. Analyzing test runs and configuration is also possible, But that is not the primary objective.

I would suggest something like
pg_gather` is standalone tooling designed to collect and analyze PostgreSQL workload, configuration, schema and usage.

- update the notes with spacing
- small fixes across paragraphs for clarity and text error fixes
@Andriciuc
Copy link
Copy Markdown
Collaborator Author

@jobinau Thank you for the feedback Jobin! I have updated the file to better reflect the information, I also made smaller clarity adjustments to paragraphs, let me know how it looks now :)

@Andriciuc Andriciuc requested a review from jobinau August 12, 2025 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants