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

Documentation review before LTS release #5757

Closed
7 tasks done
richtja opened this issue Sep 5, 2023 · 1 comment · Fixed by #5843
Closed
7 tasks done

Documentation review before LTS release #5757

richtja opened this issue Sep 5, 2023 · 1 comment · Fixed by #5843
Assignees
@clebergnu @richtja
Labels
documentation LTS release refactoring
Milestone
#103 (LTS release...

Comments

@richtja
Copy link
Contributor

richtja commented Sep 5, 2023 •
edited
Loading

It is necessary to a review of our documentation before LTS release.

What needs to be done:

  • Fix of possible spell mistakes
  • Validation of all examples
  • Fact check of all information in documentation

Chapters:
@mr-avocado mr-avocado bot moved this to Triage in Default project Sep 5, 2023
@richtja richtja moved this from Triage to In progress in Default project Sep 5, 2023
@richtja richtja self-assigned this Sep 5, 2023
richtja added a commit to richtja/avocado that referenced this issue Sep 6, 2023
@richtja
Doc fixes before LTS - Introduction section
66eed6a 
Updates to documentation in `Welcome to avocado` section to respects the
latest changes.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Sep 6, 2023
@richtja
Doc fixes before LTS - Introduction section
b4ca8d5 
Updates to documentation in `Welcome to avocado` section to respects the
latest changes.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
@richtja richtja mentioned this issue Sep 6, 2023
Merged
richtja added a commit to richtja/avocado that referenced this issue Sep 12, 2023
@richtja
Doc fixes before LTS - Avocado User’s Guide
bb4776e 
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]>
richtja added a commit to richtja/avocado that referenced this issue Sep 12, 2023
@richtja
Doc fixes before LTS - Avocado User’s Guide
9cf2f6a 
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]>
@richtja richtja mentioned this issue Sep 12, 2023
Merged
richtja added a commit to richtja/avocado that referenced this issue Sep 13, 2023
@richtja
Doc fixes before LTS - Avocado User’s Guide
ec7952c 
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]>
richtja added a commit to richtja/avocado that referenced this issue Sep 13, 2023
@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 clebergnu self-assigned this Oct 11, 2023
@richtja
Copy link
Contributor Author

richtja commented Oct 11, 2023

We need to rewrite Signal Handlers chapter, when issues #4994 and #5407 will be solved

richtja added a commit to richtja/avocado that referenced this issue Oct 12, 2023
@richtja
Doc fixes before LTS - Avocado Writers’s Guide
6b75129 
Updates to documentation in `Avocado Writer’s Guide` section to respects
the latest changes.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
@richtja richtja mentioned this issue Oct 12, 2023
Merged
richtja added a commit to richtja/avocado that referenced this issue Oct 12, 2023
@richtja
Doc fixes before LTS - Avocado Writers’s Guide
c9318a6 
Updates to documentation in `Avocado Writer’s Guide` section to respects
the latest changes.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Oct 12, 2023
@richtja
Doc fixes before LTS - Avocado Writers’s Guide
464f3f0 
Updates to documentation in `Avocado Writer’s Guide` section to respects
the latest changes.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Oct 16, 2023
@richtja
Doc fixes before LTS - Avocado Writers’s Guide
81320e2 
Updates to documentation in `Avocado Writer’s Guide` section to respects
the latest changes.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
@clebergnu clebergnu mentioned this issue Nov 8, 2023
Merged
richtja added a commit to richtja/avocado that referenced this issue Nov 28, 2023
@richtja
Unexpected unindent Sphinx-build warning fix
4a4cfd2 
Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Nov 28, 2023
@richtja
Static checks for html documentation
9eb5748 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Nov 28, 2023
@richtja
Static checks for html documentation
d496fbc 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
@richtja richtja mentioned this issue Nov 28, 2023
Merged
richtja added a commit to richtja/avocado that referenced this issue Nov 28, 2023
@richtja
Static checks for html documentation
3b75df1 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 1, 2023
@richtja
Unexpected unindent Sphinx-build warning fix
3ae5069 
Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 1, 2023
@richtja
Static checks for html documentation
17b7f93 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 1, 2023
@richtja
Static checks for html documentation
3754351 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 1, 2023
@richtja
Static checks for html documentation
2b4afe8 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 1, 2023
@richtja
Static checks for html documentation
ef617f4 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 5, 2023
@richtja
Unexpected unindent Sphinx-build warning fix
7793357 
Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 5, 2023
@richtja
Static checks for html documentation
06be3ae 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future. It makes
the readthedocs build more strict, which make it fail on any warning.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 7, 2023
@richtja
Unexpected unindent Sphinx-build warning fix
e245513 
Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 7, 2023
@richtja
Static checks for html documentation
67badbb 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future. It makes
the readthedocs build more strict, which make it fail on any warning.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 7, 2023
@richtja
Unexpected unindent Sphinx-build warning fix
7bc9844 
Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
richtja added a commit to richtja/avocado that referenced this issue Dec 7, 2023
@richtja
Static checks for html documentation
b5008fc 
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future. It makes
the readthedocs build more strict, which make it fail on any warning.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
This was referenced Dec 22, 2023
Merged
Merged
@github-project-automation github-project-automation bot moved this from In progress to Done 103 in Default project Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@clebergnu clebergnu

@richtja richtja

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

Successfully merging a pull request may close this issue.

Optional plugins review for 103.0 LTS clebergnu/avocado
2 participants
@clebergnu @richtja