Skip to content

Doc: Add pg-controldata documentation #228

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jennifer88huang
Copy link
Member

Change logs

  • Add pg-controldata documentation in both English and Chinese version.
  • Add the english version in sidebar.json file.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hiiii, @jennifer88huang welcome!🎊 Thanks for taking the effort to make our project better! 🙌 Keep making such awesome contributions!


# pg_controldata

Displays control information of a PostgreSQL database cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's OK to use the original PostgreSQL document but it would be better to use the right product name and complete the sentence.

Suggested change
Displays control information of a PostgreSQL database cluster.
The system utility `pg_controldata` displays the control information of an Apache Cloudberry cluster.


Displays control information of a PostgreSQL database cluster.

Only the user who initialized the cluster and has read access to the data directory can run the utility. The access restriction ensures the integrity and security of the sensitive control information.
Copy link
Contributor

Choose a reason for hiding this comment

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

To improve the readability.

Suggested change
Only the user who initialized the cluster and has read access to the data directory can run the utility. The access restriction ensures the integrity and security of the sensitive control information.
To run this utility, you need to initialize the cluster and have read access to the data directory. This access restriction ensures the integrity and security of the sensitive control information.


Only the user who initialized the cluster and has read access to the data directory can run the utility. The access restriction ensures the integrity and security of the sensitive control information.

## Synopsis
Copy link
Contributor

@TomShawn TomShawn Jan 24, 2025

Choose a reason for hiding this comment

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

For better markdown writing style, it is recommended to reserve a blank line between the paragraph and the preceding title, in case that consecutive lines are rendered as one line.

Suggested change
## Synopsis
## Synopsis

Comment on lines 23 to 24
| `-V` and `--version` | Print the `pg_controldata` version and exit. |
| `-?` and `--help` | Output a list of all supported arguments. It enables users to use the utility effectively. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Keep a consistent style with your first sentence of the document.

Suggested change
| `-V` and `--version` | Print the `pg_controldata` version and exit. |
| `-?` and `--help` | Output a list of all supported arguments. It enables users to use the utility effectively. |
| `-V` and `--version` | Prints the `pg_controldata` version and exit. |
| `-?` and `--help` | Outputs a list of all supported arguments. It enables users to use the utility effectively. |

| Variable | Description |
| ------------ | ------------------- |
| `-PGDATA` | The default location of data directory. You can specify the data directory on the command line, or use the environment variable `PGDATA`. |
| `-PG_COLOR` | Determine whether to use color in diagnostic messages. The available values are `always`, `auto` and `never`. Setting the value to `always` ensures that diagnostic messages are always presented in color, which enhances readability and visual identification of important information. Setting the value to `auto` enables color-coding based on the capabilities of the output terminal.Setting the value to `never` disables the usage of color entirely. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `-PG_COLOR` | Determine whether to use color in diagnostic messages. The available values are `always`, `auto` and `never`. Setting the value to `always` ensures that diagnostic messages are always presented in color, which enhances readability and visual identification of important information. Setting the value to `auto` enables color-coding based on the capabilities of the output terminal.Setting the value to `never` disables the usage of color entirely. |
| `-PG_COLOR` | Determines whether to use color in diagnostic messages. The available values are `always`, `auto`, and `never`. Setting the value to `always` ensures that diagnostic messages are always presented in color, which enhances readability and visual identification of important information. Setting the value to `auto` enables color-coding based on the capabilities of the output terminal. Setting the value to `never` disables the usage of color entirely. |

---

# pg_controldata
显示PostgreSQL数据库集群的控制信息。
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep a consistent style of whether to reserve a space between an English character and a Chinese character throughout the document.

# pg_controldata
显示PostgreSQL数据库集群的控制信息。

只有初始化集群且对数据目录有读取权限的用户才能运行此实用工具。这种访问限制确保了敏感控制信息的完整性和安全性。
Copy link
Contributor

Choose a reason for hiding this comment

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

To improve the "translationese" a bit.

Suggested change
只有初始化集群且对数据目录有读取权限的用户才能运行此实用工具。这种访问限制确保了敏感控制信息的完整性和安全性
要运行此实用程序,你需要先初始化该集群,并且有权限读取数据目录。这种访问限制确保敏感控制信息的完整性和安全性

| 环境变量 | 作用 |
| ------------ | ------------------- |
| `-PGDATA` | 数据目录的默认位置。可以用命令行或环境变量`PGDATA` 指定数据目录。 |
| `-PG_COLOR` | 该变量决定是否在诊断消息中使用颜色。可用值有 `always(始终)`, `auto(自动)` 和 `never(从不)`。将值设置为 `always(始终)` 可确保诊断消息始终以彩色显示,这样可以提高可读性并从视觉上识别重要信息。将值设置为 `auto(自动)` 可根据输出终端的功能进行颜色编码。将值设置为 `never(从不)`则完全禁用颜色。 |
Copy link
Contributor

@TomShawn TomShawn Jan 24, 2025

Choose a reason for hiding this comment

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

The Chinese explanations along with the parentheses are not part of the variable values themselves; please write them separately.

Suggested change
| `-PG_COLOR` | 该变量决定是否在诊断消息中使用颜色。可用值有 `always(始终)`, `auto(自动)``never(从不)`。将值设置为 `always(始终)` 可确保诊断消息始终以彩色显示,这样可以提高可读性并从视觉上识别重要信息。将值设置为 `auto(自动)` 可根据输出终端的功能进行颜色编码。将值设置为 `never(从不)`则完全禁用颜色。 |
| `-PG_COLOR` | 该变量决定是否在诊断消息中使用颜色。可用值有 `always`(始终)`auto`(自动)`never`(从不)。将值设置为 `always`(始终)可确保诊断消息始终以彩色显示,这样可以提高可读性并从视觉上识别重要信息。将值设置为 `auto`(自动) 可根据输出终端的功能进行颜色编码。将值设置为 `never`(从不)则完全禁用颜色。 |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants