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

[21416] Enhance Fast DDS docs with a FAQs section covering every subsection #902

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

depink5
Copy link
Contributor

@depink5 depink5 commented Sep 4, 2024

Description

Add a Frequently Asked Questions (FAQs) section to FastDDS Documentation.

Contributor Checklist

  • Commit messages follow the project guidelines.
  • N/A Code snippets related to the added documentation have been provided.
  • Documentation tests pass locally.
  • N/A Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • CI passes without warnings or errors.

depink5 and others added 3 commits August 5, 2024 13:01
* Refs #21416: Add FAQs section

Signed-off-by: Denisa <[email protected]>

* FAQ section

Signed-off-by: Denisa <[email protected]>

* Refs #21416: Frequently Asked Questions-add review comments

Signed-off-by: Denisa <[email protected]>

---------

Signed-off-by: Denisa <[email protected]>
Co-authored-by: Denisa <[email protected]>
* Refs #21416: Add FAQs section

Signed-off-by: Denisa <[email protected]>

* FAQ section

Signed-off-by: Denisa <[email protected]>

* Refs #21416: Frequently Asked Questions-add review comments

Signed-off-by: Denisa <[email protected]>

---------

Signed-off-by: Denisa <[email protected]>
Co-authored-by: Denisa <[email protected]>
Signed-off-by: Carlosespicur <[email protected]>
@depink5 depink5 added this to the v3.0.1 milestone Sep 4, 2024
@rsanchez15 rsanchez15 modified the milestones: v3.0.1 - frozen, v3.0.2 Sep 5, 2024
docs/fastdds/faq/getting_started/getting_started.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/getting_started/getting_started.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/getting_started/getting_started.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/getting_started/getting_started.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Show resolved Hide resolved
docs/fastdds/faq/rtps_layer/rtps_layer.rst Show resolved Hide resolved
docs/fastdds/faq/faq.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/discovery/discovery.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/discovery/discovery.rst Show resolved Hide resolved
docs/fastdds/faq/transport_layer/transport_layer.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/transport_layer/transport_layer.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/security/security.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/security/security.rst Show resolved Hide resolved
docs/fastdds/faq/security/security.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/logging/logging.rst Show resolved Hide resolved
docs/fastdds/faq/logging/logging.rst Outdated Show resolved Hide resolved
Signed-off-by: Denisa <[email protected]>
Copy link
Contributor

@LuciaEchevarria99 LuciaEchevarria99 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

Choose a reason for hiding this comment

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

Sort this words alphabetically through the list

Comment on lines +16 to +21
.. collapse:: What is the significance of a unique ID in the context of DDS and RTPS entities, and why is it important to have a shared ID between these entities?




|br|
Copy link
Contributor

Choose a reason for hiding this comment

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

Are all these line breaks really required? Can they be simplified into one line break?
Apply to remaining occurrences if proceeds.

Suggested change
.. collapse:: What is the significance of a unique ID in the context of DDS and RTPS entities, and why is it important to have a shared ID between these entities?
|br|
.. collapse:: What is the significance of a unique ID in the context of DDS and RTPS entities, and why is it important to have a shared ID between these entities? |br|

docs/fastdds/faq/dds_layer/dds_layer.rst Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Show resolved Hide resolved
@@ -461,7 +462,7 @@ def configure_doxyfile(

suppress_warnings = [
'cpp.duplicate_declaration',
'cpp.parse_function_declaration'
'cpp.parse_function_declaration',
Copy link
Contributor

Choose a reason for hiding this comment

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

restore?

Suggested change
'cpp.parse_function_declaration',
'cpp.parse_function_declaration'

@@ -366,6 +366,7 @@ def configure_doxyfile(
except ImportError:
pass


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

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.

5 participants