Checkbox remote nomenclature documentation upgrade #562
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pieqq
changed the title
Following a discussion with the documentation team that led to the creation of a PR on their side[1], make sure to be in the docs/ directory before triggering the different commands. This should make woke work as expected. Please note that according to woke doc[2], the parameter to set this is "workdir". [1] canonical/sphinx-docs-starter-pack#40 [2] https://github.com/marketplace/actions/run-woke
- Update glossary to include terms like DUT, Testbed, as well as Checkbox Controller and Checkbox Testbed - Clean up rst markup - Add links to glossary terms or other sections when it makes sense
Not sure why testbed is marked as an unkown word, it's in the wiktionary: https://en.wiktionary.org/wiki/testbed
Following proposal to provide better naming for Checkbox remote[1], it was decided to use the following terms: - "controller" for the entity that connects to remote DUT - "agent" for the entity that runs on DUT or Zapper connected (directly attached via various interfaces) to DUT to execute tests Since "testbed" had been originally used for the second term in the first draft, this commit addresses the "testbed" -> "agent" change. [1] https://docs.google.com/document/d/1GuR5xudmxgZ3bRMSRcuy0bZyX3We3UvooP0WT_VcXSA/
This was still useful when Checkbox was published on it, but it's not anymore.
pieqq
force-pushed
the
CHECKBOX-658/docs-remote-nomenclature
branch
from
7de0406 to
67122b4
Compare
kissiel
reviewed
Jun 27, 2023
yphus
approved these changes
Jul 10, 2023
kissiel
suggested changes
Jul 10, 2023
diohe0311
pushed a commit
that referenced
this pull request
Jul 18, 2023
* Run commands from the docs/ directory Following a discussion with the documentation team that led to the creation of a PR on their side[1], make sure to be in the docs/ directory before triggering the different commands. This should make woke work as expected. Please note that according to woke doc[2], the parameter to set this is "workdir". [1] canonical/sphinx-docs-starter-pack#40 [2] https://github.com/marketplace/actions/run-woke * Update glossary and clean up doc pages - Update glossary to include terms like DUT, Testbed, as well as Checkbox Controller and Checkbox Testbed - Clean up rst markup - Add links to glossary terms or other sections when it makes sense * Replace references to master and slave Fix CHECKBOX-658 * Rework the Checkbox remote interrupt screen explanation * Rework the page about the Checkbox remote service * Add words to spelling ignore list Not sure why testbed is marked as an unkown word, it's in the wiktionary: https://en.wiktionary.org/wiki/testbed * Fix rst reference to the launcher doc * Replace mentions of "testbed" with "agent" Following proposal to provide better naming for Checkbox remote[1], it was decided to use the following terms: - "controller" for the entity that connects to remote DUT - "agent" for the entity that runs on DUT or Zapper connected (directly attached via various interfaces) to DUT to execute tests Since "testbed" had been originally used for the second term in the first draft, this commit addresses the "testbed" -> "agent" change. [1] https://docs.google.com/document/d/1GuR5xudmxgZ3bRMSRcuy0bZyX3We3UvooP0WT_VcXSA/ * Rename [daemon] section of the launchers into [agent] section * Remove PyPI from glossary This was still useful when Checkbox was published on it, but it's not anymore. * Use warning instead of note for field deprecation comment * Address feedback regarding service and configs pages * Rename reference from DUT to Agent in configs page * Update remote explanation
diohe0311
pushed a commit
that referenced
this pull request
Jul 31, 2023
* Run commands from the docs/ directory Following a discussion with the documentation team that led to the creation of a PR on their side[1], make sure to be in the docs/ directory before triggering the different commands. This should make woke work as expected. Please note that according to woke doc[2], the parameter to set this is "workdir". [1] canonical/sphinx-docs-starter-pack#40 [2] https://github.com/marketplace/actions/run-woke * Update glossary and clean up doc pages - Update glossary to include terms like DUT, Testbed, as well as Checkbox Controller and Checkbox Testbed - Clean up rst markup - Add links to glossary terms or other sections when it makes sense * Replace references to master and slave Fix CHECKBOX-658 * Rework the Checkbox remote interrupt screen explanation * Rework the page about the Checkbox remote service * Add words to spelling ignore list Not sure why testbed is marked as an unkown word, it's in the wiktionary: https://en.wiktionary.org/wiki/testbed * Fix rst reference to the launcher doc * Replace mentions of "testbed" with "agent" Following proposal to provide better naming for Checkbox remote[1], it was decided to use the following terms: - "controller" for the entity that connects to remote DUT - "agent" for the entity that runs on DUT or Zapper connected (directly attached via various interfaces) to DUT to execute tests Since "testbed" had been originally used for the second term in the first draft, this commit addresses the "testbed" -> "agent" change. [1] https://docs.google.com/document/d/1GuR5xudmxgZ3bRMSRcuy0bZyX3We3UvooP0WT_VcXSA/ * Rename [daemon] section of the launchers into [agent] section * Remove PyPI from glossary This was still useful when Checkbox was published on it, but it's not anymore. * Use warning instead of note for field deprecation comment * Address feedback regarding service and configs pages * Rename reference from DUT to Agent in configs page * Update remote explanation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
After deciding on the new nomenclature (Testbed and Controller), the documentation needed to be updated.
This PR
Part 4. requires some attention, because I'm not entirely sure about Checkbox internals with regards to snap/daemon/service and how each of these interact with each others. I've removed what I thought was not necessary, but I could be wrong.
Click here to see the changes in action!
I've split my work into different commits for easier review.
Resolved issues
Fixes CHECKBOX-658
Tests
Checked that pages looked OK during rewriting using
make run, and checked inclusive language, spelling and links with