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

Make the onboarding guide more service-centric #480

Closed
7 tasks
lachmanfrantisek opened this issue Jun 8, 2022 · 0 comments · Fixed by #499
Closed
7 tasks

Make the onboarding guide more service-centric #480

lachmanfrantisek opened this issue Jun 8, 2022 · 0 comments · Fixed by #499
Assignees
@lachmanfrantisek

Comments

@lachmanfrantisek
Copy link
Member

Most of the new users are interested just in the service. Let's make them first-class citizens.

Acceptance criteria:

  • Onboarding guide can be used as the first page we can provide to the users.
    • No extra context is needed before reading this guide.
    • CLI is shown as a validation/debug tool.
  • Relation with Packit Service page is resolved.
    • Either by merging those two together or clear split with good linking.
  • The onboarding clearly shows how to set up Packit on GitHub/GitLab.
  • Relevant config options are linked (related to The list of config options is too long #467)
  • The jobs concept is well-described. Users can find and pick the relevant jobs. Also, it's easy to find more details and instructions.
  • The guide is easy to follow and not overwhelming (e.g. use screenshots and link the unimportant information).
  • Don't collide or merge with the release workflow guide: provide a clear, step-by-step guide for doing releases with Packit #351
@lachmanfrantisek lachmanfrantisek self-assigned this Jul 14, 2022
This was referenced Jul 14, 2022
Merged
Closed
softwarefactory-project-zuul bot added a commit that referenced this issue Jul 25, 2022
@softwarefactory-project-zuul
Merge pull request #499 from lachmanfrantisek/make-guide-service-centric
454ba4c 
Make guide service centric

Acceptance criteria from the issue:

 Onboarding guide can be used as the first page we can provide to the users.

No extra context is needed before reading this guide.
CLI is shown as a validation/debug tool.


  Relation with Packit Service page is resolved.

Either by merging those two together or clear split with good linking.


 The onboarding clearly shows how to set up Packit on GitHub/GitLab.
 Relevant config options are linked (related to #467)
 The jobs concept is well-described. Users can find and pick the relevant jobs. Also, it's easy to find more details and instructions.
 The guide is easy to follow and not overwhelming (e.g. use screenshots and link the unimportant information).
 Don't collide or merge with the release workflow guide: #351

Fixes: #480

Reviewed-by: Jiri Popelka <None>
Reviewed-by: Laura Barcziová <None>
Reviewed-by: None <None>
Reviewed-by: František Nečas <[email protected]>
Reviewed-by: Tomas Tomecek <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lachmanfrantisek lachmanfrantisek

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make guide service centric lachmanfrantisek/packit.dev
1 participant
@lachmanfrantisek