From d43fe504ffca90333e5e214a9c6c222e9d1601ca Mon Sep 17 00:00:00 2001 From: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com> Date: Tue, 15 Oct 2024 11:33:45 -0700 Subject: [PATCH] Fix Jekyll docs build error from curly braces interpretation (#2951) * Fix Jekyll docs build error from curly braces interpretation * fix spelling --- .github/actions/spelling/expect.txt | 1 + docs/HowTo/develop-subtopologies.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index f0f3582640..fd41ed7e2c 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -268,6 +268,7 @@ endcond endfunction endloc endmacro +endraw enduml ENQUEUEX enumchan diff --git a/docs/HowTo/develop-subtopologies.md b/docs/HowTo/develop-subtopologies.md index 8cd9c02a7a..8d0fcb81e6 100644 --- a/docs/HowTo/develop-subtopologies.md +++ b/docs/HowTo/develop-subtopologies.md @@ -264,6 +264,7 @@ topology MainDeployment { At this point, we want to now call our subtopology's configure/start/teardown functions within the corresponding functions of our `MainDeployment` topology. So, in `MainDeploymentTopology.cpp`: + ```cpp // at the top, include our topology.hpp #include @@ -293,6 +294,7 @@ void teardownTopology(const TopologyState& state){ MySubtopology::teardownTopology({}) } ``` + Lastly, since our RNG component has some telemetry, we need to include (or ignore) these channels within the `Packets.xml` file in this folder. As with any other component that is added to a deployment, you use the same syntax with the name of the instance followed by the name of the telemetry channel. For example: