rticommunity / rticommunity/rticonnextdds-examples
[ENH] Tutorial has incomplete resources/instructions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 148
- Forks
- 153
- PR merge metrics
- No merged PRs in 30d
Description
Enhancement description
Related to #559
I am attempting to build the second optional application in the tutorial found here: https://community.rti.com/static/documentation/developers/learn/publish-subscribe.html
This optional exercise instructs the reader to build with CMake but does not provide a CMakeLists.txt.
So, I followed the link in the tutorial to the repository, and copied/pasted the CMakeLists.txt that is provided there. However, building with this file results in the following:
CMake Error at CMakeLists.txt:18 (include):
include could not find requested file:
ConnextDdsConfigureCmakeUtils
CMake Error at CMakeLists.txt:19 (connextdds_configure_cmake_utils):
Unknown CMake command "connextdds_configure_cmake_utils".
Moderators/developers commenting on Issue #559 state that this missing file is an unnecessary utility.
It is my suggestion that, if you want tutorial readers build the example with CMake, you provide them with a working CMakeLists.txt.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the publish-subscribe tutorial and the linked repository example, then inspect the copied CMakeLists.txt and the discussion in issue #559. Verify which CMake configuration is required without ConnextDdsConfigureCmakeUtils; done means the optional application builds successfully using instructions and a working CMakeLists.txt provided by the tutorial.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100