Skip to content
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

docs: add the manager's RPC client certificate entry to the guide #2052

Merged
merged 8 commits into from
Oct 21, 2024

Conversation

studioego
Copy link
Contributor

@studioego studioego commented Apr 23, 2024

To add the manager's RPC client certificate entry to the guide.

Following the merged PR #887 , manager.toml config file's rpc-auth-manager-keypair filed is always required, even when no agents require authentication and encryption.

As a result, add the manager's RPC client certificate entry to the guide.

fix #2044

Checklist: (if applicable)

  • Documentation
    • Contents in the docs directory
    • docstrings in public interfaces and type annotations

📚 Documentation preview 📚: https://sorna--2052.org.readthedocs.build/en/2052/


📚 Documentation preview 📚: https://sorna-ko--2052.org.readthedocs.build/ko/2052/

@studioego studioego added the area:docs Documentations label Apr 23, 2024
@studioego studioego requested a review from adrysn April 23, 2024 04:07
@studioego studioego self-assigned this Apr 23, 2024
@github-actions github-actions bot added type:feature Add new features size:S 10~30 LoC labels Apr 23, 2024
changes/2052.doc.md Outdated Show resolved Hide resolved
Copy link
Member

@adrysn adrysn left a comment

Choose a reason for hiding this comment

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

I added some comments.

@studioego
Copy link
Contributor Author

I fixed typos for the latest version.

@studioego studioego requested a review from adrysn April 25, 2024 08:28
@achimnol achimnol requested a review from YEONFEEL96 July 15, 2024 09:02
Copy link

@YEONFEEL96 YEONFEEL96 left a comment

Choose a reason for hiding this comment

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

Modified some explanation to make document better.

Copy link

@YEONFEEL96 YEONFEEL96 left a comment

Choose a reason for hiding this comment

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

made some changes in description, such as key pair to kaypair, etc. Was only able to change the newly added part.

docs/install/install-from-package/install-manager.rst Outdated Show resolved Hide resolved
docs/install/install-from-package/install-manager.rst Outdated Show resolved Hide resolved
To add the manager's RPC client certificate entry to the guide.

Following the merged PR #887 , manager.toml config file's rpc-auth-manager-keypair filed is always required,
even when no agents require authentication and encryption.

As a result, add the manager's RPC client certificate entry to the guide.

fix #2044
add: news fragment
fix typos for the latest version
doc: change absolute path to relative path on manager.toml example
On the example of manager.toml, some key's value use absolute path.
As a result, removed hardcoded references(absolute path) and modified relative path
fix typos
@achimnol achimnol force-pushed the docs/add-manager-rpc-client-certificate branch from efa8541 to 93d16a7 Compare October 21, 2024 08:20
…db container

- Also split the lines by sentence boundaries.
  (FYI: .editorconfig already says .md/.rst files have no line length limits!)
@achimnol achimnol added this to the 24.03 milestone Oct 21, 2024
@achimnol achimnol added this pull request to the merge queue Oct 21, 2024
Merged via the queue into main with commit 0dd465d Oct 21, 2024
20 checks passed
@achimnol achimnol deleted the docs/add-manager-rpc-client-certificate branch October 21, 2024 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Documentations size:S 10~30 LoC type:feature Add new features
Projects
None yet
4 participants