Make guide service centric #499

lachmanfrantisek · 2022-07-14T07:13:42Z

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 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

Fixes: #480

softwarefactory-project-zuul · 2022-07-14T07:15:47Z

Build succeeded.

✔️ pre-commit SUCCESS in 1m 32s
✔️ hugo SUCCESS in 1m 00s

softwarefactory-project-zuul · 2022-07-18T08:58:41Z

Build succeeded.

✔️ pre-commit SUCCESS in 1m 32s
✔️ hugo SUCCESS in 1m 06s

jpopelka

Looks OK to me so far 👍

content/docs/guide.md

jpopelka · 2022-07-19T10:35:17Z

content/docs/guide.md

 # downstream (Fedora) RPM package name
-downstream_package_name: packit.dev
+downstream_package_name: directory


This is the second time we show the output of packit init on this page, but I can't decide which one to remove, so I think I'm fine with it.
So just heads up to make sure you are aware of it.

Yes, I am on the same boat with this. I can't decide..;)

Well at this point, folks should already have their packit.yamls prepared, so I'd drop this one.

lbarcziova

very nice write-up so far, much clearer!

content/docs/guide.md

lbarcziova · 2022-07-19T16:38:18Z

content/docs/guide.md

+Take a look at the tables [here](/docs/actions/) to know what actions are available for each job.
+
+
+### How to try that for real


since this is mainly about testing the RPM builds locally, would it make sense to rename this and be more specific?

This was aimed to verify the build went well locally and that there is a high chance it will work in the service. At least, that was the goal. (I don't want to focus on using CLI for actual usage, just as a way how to reproduce/debug problems...)

I am still not satisfied with that -- at least, there is that duplicate packit init output...

Signed-off-by: Frantisek Lachman <[email protected]>

This is intentionally really basic. This does not cover the authentication. Fixes: packit#470 Signed-off-by: Frantisek Lachman <[email protected]>

Signed-off-by: Frantisek Lachman <[email protected]>

Fixes: packit#468 Signed-off-by: Frantisek Lachman <[email protected]>

…port https://github.com/packit/research/tree/main/improve-service-processing#problematic-parts-of-the-process Signed-off-by: Frantisek Lachman <[email protected]>

softwarefactory-project-zuul · 2022-07-20T07:27:53Z

Build succeeded.

✔️ pre-commit SUCCESS in 1m 27s
✔️ hugo SUCCESS in 1m 06s

FrNecas

The content and structure overall looks very good! I've just added a couple of nitpicks regarding grammar, readability and similar things, otherwise LGTM

content/docs/guide.md

FrNecas · 2022-07-21T10:17:50Z

content/docs/guide.md

+
+## 3. Configuration
+
+Packit uses a configuration file to let Packit know what to do, when to do it and how.


Suggestion: Packit uses a configuration file for specifying what to do, when and how to do it.

content/docs/guide.md

Co-authored-by: František Nečas <[email protected]>

lachmanfrantisek · 2022-07-21T12:31:00Z

@FrNecas Thanks for such a detailed grammar&consistency check!

softwarefactory-project-zuul · 2022-07-21T12:33:04Z

Build succeeded.

✔️ pre-commit SUCCESS in 1m 41s
✔️ hugo SUCCESS in 1m 46s

FrNecas

Last nitpicks, otherwise LGTM!

FrNecas · 2022-07-21T12:34:17Z

content/docs/_index.md

@@ -8,7 +8,6 @@ bookCollapseSection: true

 * [About]({{< ref "about" >}}) - Key principles of Packit.
 * [Onboarding Guide]({{< ref "guide" >}}) - How to start using Packit.
-* [Packit Service]({{< ref "packit-service" >}}) - GitHub App that helps you continuously ensure that your project work in Fedora OS.


This link is still valid, is it not? So it should probably be kept here.

But it's a duplicate of the one above. (There are no longer two pages.)

content/docs/guide.md

lbarcziova

🚀

Co-authored-by: František Nečas <[email protected]>

softwarefactory-project-zuul · 2022-07-21T17:27:55Z

Build failed.

❌ pre-commit NODE_FAILURE in 0s
❌ hugo NODE_FAILURE in 0s

TomasTomecek

This is such a great improvement, I love this!

Just a few small suggestions.

content/docs/CLI/_index.md

content/docs/guide.md

TomasTomecek · 2022-07-22T08:13:00Z

content/docs/guide.md

 # downstream (Fedora) RPM package name
-downstream_package_name: packit.dev
+downstream_package_name: directory


Well at this point, folks should already have their packit.yamls prepared, so I'd drop this one.

It's hard to maintain up-to-date state and it's not relevant to users. Signed-off-by: Frantisek Lachman <[email protected]>

softwarefactory-project-zuul · 2022-07-22T10:54:19Z

Build failed.

❌ pre-commit NODE_FAILURE in 0s
❌ hugo NODE_FAILURE in 0s

morucci · 2022-07-22T11:16:46Z

recheck

softwarefactory-project-zuul · 2022-07-22T11:19:14Z

Build succeeded.

✔️ pre-commit SUCCESS in 1m 17s
✔️ hugo SUCCESS in 51s

…vice Signed-off-by: Frantisek Lachman <[email protected]>

Signed-off-by: Frantisek Lachman <[email protected]>

softwarefactory-project-zuul · 2022-07-22T12:03:16Z

Build succeeded.

✔️ pre-commit SUCCESS in 1m 25s
✔️ hugo SUCCESS in 1m 03s

Co-authored-by: Tomas Tomecek <[email protected]>

lachmanfrantisek · 2022-07-25T07:17:53Z

@jpopelka @lbarcziova @FrNecas @TomasTomecek Thanks for the reviews!

Anything else I should resolve/cover/add/update?

softwarefactory-project-zuul · 2022-07-25T07:19:00Z

Build succeeded.

✔️ pre-commit SUCCESS in 1m 36s
✔️ hugo SUCCESS in 1m 02s

lachmanfrantisek · 2022-07-25T13:07:53Z

I am going to merge this but let me know (or create a new issue) in case of any additional suggestions/notes/...

Thanks for the reviews!

softwarefactory-project-zuul · 2022-07-25T13:11:20Z

Build succeeded (gate pipeline).

✔️ pre-commit SUCCESS in 1m 15s

Should have been removed in packit#499 Signed-off-by: Frantisek Lachman <[email protected]>

lachmanfrantisek mentioned this pull request Jul 14, 2022

Redirect new users to the notification issue packit/packit-service#1481

Closed

4 tasks

lachmanfrantisek force-pushed the make-guide-service-centric branch from 64ee315 to a200c23 Compare July 18, 2022 08:56

jpopelka reviewed Jul 19, 2022

View reviewed changes

lbarcziova reviewed Jul 19, 2022

View reviewed changes

lachmanfrantisek added 9 commits July 20, 2022 09:22

Make the onboarding guide more service-centric

09ffc79

Signed-off-by: Frantisek Lachman <[email protected]>

Avoid using term 'Packit Service'

825b0cf

Signed-off-by: Frantisek Lachman <[email protected]>

Fix the guide link

e1a1ffb

Signed-off-by: Frantisek Lachman <[email protected]>

Add screenshots to the service guide for the setup and approval

e31ff5f

Signed-off-by: Frantisek Lachman <[email protected]>

Mention usage of Packit as a GitLab pipeline

3df56d2

This is intentionally really basic. This does not cover the authentication. Fixes: packit#470 Signed-off-by: Frantisek Lachman <[email protected]>

Mention that self-approval is used just on GitHub

6bb4d9e

Signed-off-by: Frantisek Lachman <[email protected]>

Mention comment commands for other jobs as well

715a095

Signed-off-by: Frantisek Lachman <[email protected]>

Add a part about version handling

de3ed04

Fixes: packit#468 Signed-off-by: Frantisek Lachman <[email protected]>

Do not mention json file suffix for config so we can remove the sup…

8b92038

…port https://github.com/packit/research/tree/main/improve-service-processing#problematic-parts-of-the-process Signed-off-by: Frantisek Lachman <[email protected]>

lachmanfrantisek force-pushed the make-guide-service-centric branch from a200c23 to 8b92038 Compare July 20, 2022 07:25

lachmanfrantisek marked this pull request as ready for review July 21, 2022 07:10

FrNecas reviewed Jul 21, 2022

View reviewed changes

Apply suggestions from code review by @FrNecas

596b820

Co-authored-by: František Nečas <[email protected]>

FrNecas approved these changes Jul 21, 2022

View reviewed changes

lbarcziova approved these changes Jul 21, 2022

View reviewed changes

Update content/docs/guide.md by @FrNecas

54f55ee

Co-authored-by: František Nečas <[email protected]>

TomasTomecek reviewed Jul 22, 2022

View reviewed changes

Remove service-config from the documentation

8365cb9

It's hard to maintain up-to-date state and it's not relevant to users. Signed-off-by: Frantisek Lachman <[email protected]>

lachmanfrantisek added 2 commits July 22, 2022 14:00

Make it explicit that Packit CLI does not communicate with Packit ser…

ecf4847

…vice Signed-off-by: Frantisek Lachman <[email protected]>

Improve and deduplicate packit init output

911c48c

Signed-off-by: Frantisek Lachman <[email protected]>

Update content/docs/CLI/_index.md by @TomasTomecek

d81897b

Co-authored-by: Tomas Tomecek <[email protected]>

TomasTomecek approved these changes Jul 25, 2022

View reviewed changes

lbarcziova approved these changes Jul 25, 2022

View reviewed changes

lachmanfrantisek added the mergeit When set, zuul wil gate and merge the PR. label Jul 25, 2022

softwarefactory-project-zuul bot merged commit 454ba4c into packit:main Jul 25, 2022

lachmanfrantisek deleted the make-guide-service-centric branch July 25, 2022 13:24

lachmanfrantisek added a commit to lachmanfrantisek/packit.dev that referenced this pull request Jul 27, 2022

Remove /docs/packit-service.md since it has been merged to guide

294d180

Should have been removed in packit#499 Signed-off-by: Frantisek Lachman <[email protected]>

lachmanfrantisek added a commit to lachmanfrantisek/packit.dev that referenced this pull request Jul 28, 2022

Remove /docs/packit-service.md since it has been merged to guide

c629fb6

Should have been removed in packit#499 Signed-off-by: Frantisek Lachman <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make guide service centric #499

Make guide service centric #499

lachmanfrantisek commented Jul 14, 2022 •

edited

Loading

softwarefactory-project-zuul bot commented Jul 14, 2022

softwarefactory-project-zuul bot commented Jul 18, 2022

jpopelka left a comment

jpopelka Jul 19, 2022

lachmanfrantisek Jul 20, 2022

TomasTomecek Jul 22, 2022

lbarcziova left a comment

lbarcziova Jul 19, 2022

lachmanfrantisek Jul 20, 2022

softwarefactory-project-zuul bot commented Jul 20, 2022

FrNecas left a comment

FrNecas Jul 21, 2022

lachmanfrantisek commented Jul 21, 2022

softwarefactory-project-zuul bot commented Jul 21, 2022

FrNecas left a comment

FrNecas Jul 21, 2022

lachmanfrantisek Jul 21, 2022

lbarcziova left a comment

softwarefactory-project-zuul bot commented Jul 21, 2022

TomasTomecek left a comment

TomasTomecek Jul 22, 2022

softwarefactory-project-zuul bot commented Jul 22, 2022

morucci commented Jul 22, 2022

softwarefactory-project-zuul bot commented Jul 22, 2022

softwarefactory-project-zuul bot commented Jul 22, 2022

lachmanfrantisek commented Jul 25, 2022

softwarefactory-project-zuul bot commented Jul 25, 2022

lachmanfrantisek commented Jul 25, 2022 •

edited

Loading

softwarefactory-project-zuul bot commented Jul 25, 2022

		Take a look at the tables [here](/docs/actions/) to know what actions are available for each job.


		### How to try that for real


		## 3. Configuration

		Packit uses a configuration file to let Packit know what to do, when to do it and how.

Make guide service centric #499

Make guide service centric #499

Conversation

lachmanfrantisek commented Jul 14, 2022 • edited Loading

softwarefactory-project-zuul bot commented Jul 14, 2022

softwarefactory-project-zuul bot commented Jul 18, 2022

jpopelka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbarcziova left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Jul 20, 2022

FrNecas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lachmanfrantisek commented Jul 21, 2022

softwarefactory-project-zuul bot commented Jul 21, 2022

FrNecas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbarcziova left a comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Jul 21, 2022

TomasTomecek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Jul 22, 2022

morucci commented Jul 22, 2022

softwarefactory-project-zuul bot commented Jul 22, 2022

softwarefactory-project-zuul bot commented Jul 22, 2022

lachmanfrantisek commented Jul 25, 2022

softwarefactory-project-zuul bot commented Jul 25, 2022

lachmanfrantisek commented Jul 25, 2022 • edited Loading

softwarefactory-project-zuul bot commented Jul 25, 2022

lachmanfrantisek commented Jul 14, 2022 •

edited

Loading

lachmanfrantisek commented Jul 25, 2022 •

edited

Loading