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

Created using advanced configs (infra) #642

Merged
merged 14 commits into from
Jan 9, 2024
Merged

Conversation

Hook25
Copy link
Collaborator

@Hook25 Hook25 commented Jul 27, 2023

Description

This introduces several advanced topics for configurations like config inheritance and custom report and transport

Resolved issues

Resolves: https://warthogs.atlassian.net/browse/CHECKBOX-757

Documentation

N/A

Tests

N/A

Minor: new plugin to put todos in the docs
@Hook25 Hook25 requested a review from pieqq July 27, 2023 08:04
diohe0311
diohe0311 previously approved these changes Aug 2, 2023
Copy link
Contributor

@diohe0311 diohe0311 left a comment

Choose a reason for hiding this comment

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

LGTM +1
The UI section is very useful when testing new job!

docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
pieqq
pieqq previously requested changes Aug 4, 2023
Copy link
Collaborator

@pieqq pieqq left a comment

Choose a reason for hiding this comment

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

I still have a feeling that this is not a tutorial (we are not guiding the user through something in order to achieve something, we are just listing a lot of options from the launchers and explaining what's the use for them), and this is duplicating a lot of info that can be found elsewhere in the documentation. Some sections feel like a how-to, some are more like a reference document...

That said, I've added inline comments, but I think we need feedback from other people like @yphus or @kissiel, or people who have a better understanding of the documentation process.

docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
@tang-mm tang-mm self-assigned this Dec 1, 2023
Copy link
Collaborator

@mz2 mz2 left a comment

Choose a reason for hiding this comment

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

Please split into separate howtos.

docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/advanced-config.rst Outdated Show resolved Hide resolved
@tang-mm
Copy link
Collaborator

tang-mm commented Dec 20, 2023

Added a few more changes:

  • change the tutorial to focus on "Customize test reports"
  • change the original configuration renaming and configuration inheritance sections into explanation
  • split into new how-to guides:
    • auto-retry
    • ui-verbosity
  • update format in reference/launcher to use definition list

Preview: https://canonical-checkbox--642.com.readthedocs.build/en/642/tutorial/using-checkbox/generate-report.html

@tang-mm tang-mm changed the title Created using advanced configs Created using advanced configs (infra) Dec 20, 2023
@tang-mm tang-mm requested review from mz2 and diohe0311 January 3, 2024 13:47
mz2
mz2 previously approved these changes Jan 9, 2024
Copy link
Collaborator

@mz2 mz2 left a comment

Choose a reason for hiding this comment

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

Great stuff reworking this. I'd help you resolve the conflicts to merge but I don't feel confident doing it the right way => off to you. nevermind, sorted the conflicts out, I'll set it to automerge.

Copy link
Contributor

@kissiel kissiel left a comment

Choose a reason for hiding this comment

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

Monumental job!
Looks great!

@kissiel kissiel merged commit 07260d6 into main Jan 9, 2024
6 checks passed
@kissiel kissiel deleted the advanced_config_tutorial branch January 9, 2024 19:44
LiaoU3 pushed a commit to LiaoU3/checkbox that referenced this pull request Mar 20, 2024
* Created using advanced configs

Minor: new plugin to put todos in the docs

* Fixed spelling

* Minor: fixed typo

* Implemented feedback from review

* Apply suggestions from code review

Co-authored-by: Matias Piipari <[email protected]>

* update format in reference

* add config inheritance to explanation

* add auto-retry how-to guide

* add ui verbosity how-to guide

* rework tutorial

* add syntax highlighting

* add spelling check exception

---------

Co-authored-by: tang-mm <[email protected]>
Co-authored-by: Matias Piipari <[email protected]>
Co-authored-by: MengT <[email protected]>
binli pushed a commit to binli/checkbox that referenced this pull request Mar 22, 2024
* Created using advanced configs

Minor: new plugin to put todos in the docs

* Fixed spelling

* Minor: fixed typo

* Implemented feedback from review

* Apply suggestions from code review

Co-authored-by: Matias Piipari <[email protected]>

* update format in reference

* add config inheritance to explanation

* add auto-retry how-to guide

* add ui verbosity how-to guide

* rework tutorial

* add syntax highlighting

* add spelling check exception

---------

Co-authored-by: tang-mm <[email protected]>
Co-authored-by: Matias Piipari <[email protected]>
Co-authored-by: MengT <[email protected]>
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.

6 participants