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

[22616] Easy Mode enhancement and tutorial docs #233

Merged
merged 7 commits into from
Jan 23, 2025
Merged

Conversation

Mario-DL
Copy link
Member

@Mario-DL Mario-DL commented Jan 15, 2025

This PR adds the following documentation:

  • A new enhancement page Auto Discovery Server Mode in which the feature is explained.
  • A simple deployment tutorial on how to use it.

This PR must be merged after

@Mario-DL
Copy link
Member Author

When Fast DDS docs PR gets merged, need to replace a TODO with the corresponding link

Signed-off-by: Mario Dominguez <[email protected]>
@Mario-DL Mario-DL changed the title [22616] Auto Discovery Server Mode enhancement and tutorial docs [22616] Easy Mode enhancement and tutorial docs Jan 17, 2025
@Mario-DL
Copy link
Member Author

When Fast DDS docs PR gets merged, need to replace a TODO with the corresponding link.
Also, add that the feature is not available in windows

Copy link
Contributor

@cferreiragonz cferreiragonz left a comment

Choose a reason for hiding this comment

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

Great job explaining the whole feature and illustrating it with all the figures!
Just some suggestions

docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/tutorials/core/deployment/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/tutorials/core/deployment/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
Signed-off-by: Mario Dominguez <[email protected]>
Copy link
Contributor

@cferreiragonz cferreiragonz left a comment

Choose a reason for hiding this comment

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

Last three typos

docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/tutorials/core/deployment/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/tutorials/core/deployment/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
Signed-off-by: Mario Dominguez <[email protected]>
Copy link
Contributor

@cferreiragonz cferreiragonz left a comment

Choose a reason for hiding this comment

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

LGTM with green CI

docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Show resolved Hide resolved
docs/rst/enhancements/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/tutorials/core/deployment/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/tutorials/core/deployment/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
docs/rst/tutorials/core/deployment/easy_mode/easy_mode.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@rsanchez15 rsanchez15 left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@Mario-DL Mario-DL merged commit 92ad537 into main Jan 23, 2025
6 checks passed
@Mario-DL Mario-DL deleted the docs/ds_auto_mode branch January 23, 2025 07:55
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.

3 participants