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

Doc: Move Class overview section somewhere more prominent #3077

Open
LecrisUT opened this issue Jul 3, 2024 · 2 comments
Open

Doc: Move Class overview section somewhere more prominent #3077

LecrisUT opened this issue Jul 3, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@LecrisUT
Copy link
Contributor

LecrisUT commented Jul 3, 2024

Particularly on the page, Phases and Steps parts should be made more visible so that users can more easily know:

  • The steps order
  • Which steps are guestless/guestful

I often get tripped up when I forget to add a discover step and I don't see anything running. Another example is from #3065 where it is easier to visualize where to put the container setup steps, if they know the step order and the concepts of guestless/guestful it helps intuit provision and prepare steps.

@happz happz added the documentation Improvements or additions to documentation label Jul 3, 2024
@happz
Copy link
Collaborator

happz commented Jul 3, 2024

I'd argue that this page is not supposed to be the primary source of information about steps for end users. The order of steps, the fact you need discover to discover tests, all the things you described are valid points, but more for the users while this particular page is for contributors. There is definitely an overlap between these two groups, but a small one. I'd prefer making improvements reflecting the missing key concepts on pages like https://tmt.readthedocs.io/en/stable/spec.html or https://tmt.readthedocs.io/en/stable/guide.html#the-first-steps.

I mean, "The Common class is the parent of most of the available classes, it provides common methods for logging, running commands and workdir handling.", that's hardly the way we should teach end users about the order of steps and that prepare runs things on a guest while discover runs things on user's workstation.

I believe @psss has some plans to improve the guide, introduction, first steps, refactoring the docs, so, FYI, @psss.

@LecrisUT
Copy link
Contributor Author

LecrisUT commented Jul 3, 2024

I'd argue that this page is not supposed to be the primary source of information about steps for end users

Sure sure. It's not navigable for a user, just using that to reference where those concepts are being documented. The main thing is just to move the concepts from there higher up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants