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

Merged
merged 5 commits into from
Sep 26, 2024

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 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 Outdated 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 Outdated 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/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 Outdated 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
docs/fastdds/faq/xml_profiles/xml_profiles.rst Outdated Show resolved Hide resolved
depink5 and others added 3 commits September 24, 2024 16:31
* 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]>
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

docs/spelling_wordlist.txt 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 Outdated Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
Signed-off-by: Denisa <[email protected]>
docs/spelling_wordlist.txt Outdated Show resolved Hide resolved
docs/fastdds/faq/dds_layer/dds_layer.rst Outdated Show resolved Hide resolved
docs/fastdds/faq/xml_profiles/xml_profiles.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@JesusPoderoso JesusPoderoso left a comment

Choose a reason for hiding this comment

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

Really good job @depink5!! 🏅
LGTM

@rsanchez15 rsanchez15 merged commit 5e9e5db into master Sep 26, 2024
4 checks passed
@rsanchez15 rsanchez15 deleted the feature/faq branch September 26, 2024 08:39
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