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

The list of config options is too long #467

Open
4 tasks
lachmanfrantisek opened this issue May 26, 2022 · 3 comments
Open
4 tasks

The list of config options is too long #467

lachmanfrantisek opened this issue May 26, 2022 · 3 comments

Comments

@lachmanfrantisek
Copy link
Member

lachmanfrantisek commented May 26, 2022 •
edited
Loading

We have a lot of config options described on this page: https://packit.dev/docs/configuration/

The main issue is that users do not know what option is relevant to them in the specific situation.

  • One can easily send a link for the specific config option, but users usually do not find it.
  • It is unclear what config options are relevant for the given actions.
  • The config options are not linked from the onboarding guide.

TODO:

  • remove service config description (not needed and not up-to-date)
  • create a separate (sub)pages for each job (similar to CLI commands)
@TomasTomecek
Copy link
Member

...and will be even longer in the future

@lachmanfrantisek lachmanfrantisek mentioned this issue Jun 8, 2022
Closed
7 tasks
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]>
@stale
Copy link

stale bot commented Sep 21, 2022

This issue has been marked as stale because it hasn't seen any
activity for the last 60 days.

Stale issues are closed after 14 days, unless the label is removed
by a maintainer or someone comments on it.

This is done in order to ensure that open issues are still relevant.

Thank you for your contribution! 🦄 🚀 🤖

(Note: issues labeled with pinned or EPIC are
never marked as stale.)

@stale stale bot added the stale Is the issue still valid? label Sep 21, 2022
@TomasTomecek TomasTomecek removed the stale Is the issue still valid? label Oct 4, 2022
@csomh csomh mentioned this issue Nov 1, 2022
Closed
@TomasTomecek TomasTomecek mentioned this issue Dec 7, 2022
Closed
@TomasTomecek
Copy link
Member

please see #559 for feedback we got from anaconda

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Packit Kanban Board
Status: backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@TomasTomecek @lachmanfrantisek