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.

Sign up for GitHub

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

Jump to bottom

Doc fixes before LTS - Avocado User’s Guide #5763

Merged
merged 3 commits into from
Oct 5, 2023
Merged

Doc fixes before LTS - Avocado User’s Guide #5763

merged 3 commits into from
Oct 5, 2023

Conversation

richtja
Copy link
Contributor

@richtja richtja commented Sep 12, 2023

Updates to documentation in Avocado User’s Guide section to respects
the latest changes.

Reference: #5757

@richtja
Test tags example
d582c06 
Let's move `tags` test script from selftests to examples. With such
change we can use this test in other places, for example in tags
documentation.

Signed-off-by: Jan Richter <[email protected]>
@richtja
Doc about tags update
6c339ca 
It uses `tags.py` example instead of old and removed `perf.py` to
explain tags mechanism of avocado.

Signed-off-by: Jan Richter <[email protected]>
@richtja richtja requested a review from clebergnu September 12, 2023 15:24
@richtja richtja self-assigned this Sep 12, 2023
@mr-avocado
Copy link

mr-avocado bot commented Sep 12, 2023

Dear contributor,
Avocado is currently under sprint #103, which is due to release an LTS (Long Term Stability) release.
Please avoid merging changes that do not fall into these categories:

  • Bug fixes
  • Usability Improvements
  • Documentation updates

As for the Avocado utility modules (“avocado.utils”) it is OK to introduce new functionality,
but changes to the existing APIs (including interface and behavior) should be avoided.
These kind of changes should wait until sprint #104.

clebergnu
clebergnu approved these changes Sep 13, 2023
View reviewed changes
Copy link
Contributor

@clebergnu clebergnu left a comment

Choose a reason for hiding this comment

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

This is a great doc update @richtja , thanks for that! There's just one "strong suggestion" about the nrunner being the default (which I believe we should omit). Let me know what you think.

docs/source/guides/user/chapters/dependencies.rst Outdated Show resolved Hide resolved
docs/source/guides/user/chapters/installing.rst Show resolved Hide resolved
@richtja
Doc fixes before LTS - Avocado User’s Guide
8511ce7 
Updates to documentation in `Avocado User’s Guide` section to respects
the latest changes.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
@clebergnu
Copy link
Contributor

/packit copr-build

@clebergnu clebergnu merged commit ccaa66c into avocado-framework:master Oct 5, 2023
@richtja richtja deleted the doc_user_guide branch October 9, 2023 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clebergnu clebergnu clebergnu approved these changes

Assignees

@richtja richtja

Labels
documentation
Projects
Default project
Archived in project
Milestone
#103 (LTS release - Sound of Freedom)
Development

Successfully merging this pull request may close these issues.
2 participants
@richtja @clebergnu