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

Add Checkbox remote base tutorial #632

Merged
merged 4 commits into from
Aug 8, 2023
Merged

Conversation

pieqq
Copy link
Collaborator

@pieqq pieqq commented Jul 21, 2023

Description

Add checkbox remote tutorial.

Resolved issues

CHECKBOX-755

Tests

Tested locally with cd docs && make install && make run. There is one spelling mistake when running make spelling, but it will be ironed out by another PR (#627 ) and anyway, it's "TODO" which will be replaced once I know more about the other sections being written and the tutorial test plan(s).

The "screenshot" of the interrupt screen is not required anymore since
it's been moved to the Checkbox remote tutorial.

Rphrase the explanations of the different choices to better reflect
reality.
In its current state, the session running on the agent is paused when
the controller disconnects, and resumed when the controller reconnects
in order to perform some kind of sign off for each job run.

This may change in the future, but for the moment, renaming the UI
choice to better reflect current reality.
@pieqq pieqq requested review from kissiel and Hook25 July 21, 2023 14:28
Copy link
Collaborator

@Hook25 Hook25 left a comment

Choose a reason for hiding this comment

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

+1, look all right to me, I would change a couple of minor things but overall it is very good!

docs/tutorial/using-checkbox/basic-remote.rst Outdated Show resolved Hide resolved
Comment on lines +40 to +41
When you install Checkbox on a device, a Systemd service is started to turn
this device into a Checkbox agent.
Copy link
Collaborator

Choose a reason for hiding this comment

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

If the service is not running right now, don't worry, skip the next step

It should be enabled and running, but it could be that it is not for whatever reason, one should not stop reading and start debugging the service installation right here and now

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In the install section, the user has installed Checkbox using snap install. This installs and activates the systemd service. If the service does not run, it's a bug on our side.

Copy link
Collaborator

Choose a reason for hiding this comment

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

yes, but what if I run this tutorial and I stop midway through not paying attention. I was more addressing the human factor here, the system might be in a dirty state, if it matters (here it does not) point to how to fix it where it makes sense, if it does not matter, state it.

docs/tutorial/using-checkbox/basic-remote.rst Show resolved Hide resolved
@pieqq pieqq merged commit 1b59d53 into main Aug 8, 2023
13 checks passed
@pieqq pieqq deleted the CHECKBOX-755/base-remote-tutorial branch August 8, 2023 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants