canonical / real-time-ubuntu-docs

Real-time Ubuntu documentation
https://documentation.ubuntu.com/real-time
0 stars 1 forks source link

doc(how-to): Measure maximum latency #7

Closed locnnil closed 4 months ago

locnnil commented 4 months ago

RTD preview

lblythen commented 4 months ago

Fixing "interations" (which I missed in my review - sorry) and "aborded" will remove two objections from the spelling check. Add OSAL and cyclictest to docs/.wordlist.txt to avoid the remaining two.

The RTD test is failing because your new How-to isn't indexed - it doesn't appear in any ToC. Indexing it requires some rearrangement, because docs/how-to/index.rst is occupied by the only How-to that currently exists - an unfortunate mandate from On High. Happy to do that for if you like, or perhaps more usefully to go through it with you on Meet. Let me know your preference.

locnnil commented 4 months ago

Happy to do that for if you like, or perhaps more usefully to go through it with you on Meet. Let me know your preference.

Sure, we can schedule a Meet call to fix this.

lblythen commented 4 months ago

Now that your PR #8's merged, you could perhaps add this new How-to to the ToC in docs/how-to/index.rst and include that change in this PR. That should be acceptable practice: indexing a new document is part of adding the document itself, along with updating .wordlist.txt as you've done - together they're an atomic update.

locnnil commented 4 months ago

Now that your PR #8's merged, you could perhaps add this new How-to to the ToC in docs/how-to/index.rst and include that change in this PR. That should be acceptable practice: indexing a new document is part of adding the document itself, along with updating .wordlist.txt as you've done - together they're an atomic update.

Done! Thank you!