Skip to content

docs: add taosk --view-config and --edit-file usage#35155

Merged
guanshengliang merged 11 commits intomainfrom
feat/main/taosk-edit-encrypt-file
Apr 17, 2026
Merged

docs: add taosk --view-config and --edit-file usage#35155
guanshengliang merged 11 commits intomainfrom
feat/main/taosk-edit-encrypt-file

Conversation

@xiao-77
Copy link
Copy Markdown
Contributor

@xiao-77 xiao-77 commented Apr 16, 2026

  • Add section for viewing encrypted configuration files
  • Add section for editing encrypted configuration files with detailed workflow
  • Include usage examples and important notes
  • Update both Chinese and English documentation

Description

Issue(s)

  • Close/close/Fix/fix/Resolve/resolve: Issue Link

Checklist

Please check the items in the checklist if applicable.

  • Is the user manual updated?
  • Are the test cases passed and automated?
  • Is there no significant decrease in test coverage?

- Add section for viewing encrypted configuration files
- Add section for editing encrypted configuration files with detailed workflow
- Include usage examples and important notes
- Update both Chinese and English documentation
@xiao-77 xiao-77 requested a review from guanshengliang as a code owner April 16, 2026 07:14
Copilot AI review requested due to automatic review settings April 16, 2026 07:14
@xiao-77 xiao-77 requested a review from zitsen as a code owner April 16, 2026 07:14
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation in both English and Chinese for viewing and editing encrypted configuration files using the taosk tool. Feedback was provided to include the data directory flag (-d) in the example commands within the notes section for consistency and to ensure the commands function correctly in non-default environments.

Comment thread docs/en/08-operation/16-security.md Outdated
Comment thread docs/zh/08-operation/16-security.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for using taosk to view and edit encrypted configuration files, extending the existing “Storage Security / TDE” operational guidance.

Changes:

  • Document taosk --view-config to decrypt and display encrypted config files.
  • Document taosk --edit-file workflow for editing encrypted config files via a temporary decrypted file and re-encryption.
  • Apply the same additions to both Chinese and English security operation docs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/zh/08-operation/16-security.md Adds Chinese sections for viewing/editing encrypted configuration files with taosk.
docs/en/08-operation/16-security.md Adds English sections for viewing/editing encrypted configuration files with taosk.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/zh/08-operation/16-security.md Outdated
Comment thread docs/en/08-operation/16-security.md
Comment thread docs/en/08-operation/16-security.md Outdated
Comment thread docs/zh/08-operation/16-security.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 17, 2026 02:02
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/zh/08-operation/16-security.md Outdated
Comment thread docs/zh/08-operation/16-security.md
xiao-77 and others added 3 commits April 17, 2026 10:07
Copilot AI review requested due to automatic review settings April 17, 2026 02:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/zh/08-operation/16-security.md
Comment thread docs/zh/08-operation/16-security.md Outdated
Comment thread docs/en/08-operation/16-security.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 17, 2026 02:14
xiao-77 and others added 2 commits April 17, 2026 10:14
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/en/08-operation/16-security.md
Comment thread docs/en/08-operation/16-security.md
Comment thread docs/zh/08-operation/16-security.md
Comment thread docs/zh/08-operation/16-security.md
Comment thread docs/en/08-operation/16-security.md
@guanshengliang guanshengliang merged commit db2217c into main Apr 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants