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

Document how to register new packages #2485

Open
fridex opened this issue Apr 1, 2022 · 5 comments
Open

Document how to register new packages #2485

fridex opened this issue Apr 1, 2022 · 5 comments
Labels
area/documentation Issues or PRs related to documentation, tutorials, examples, ... documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@fridex
Copy link
Contributor

fridex commented Apr 1, 2022

Is your feature request related to a problem? Please describe.

As @codificat pointed out, let's have documentation that states how to register Python packages to the system. This documentation could state how to register Python packages and also what is happening in the system when a new package is solved.
@fridex fridex added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 1, 2022
@sesheta sesheta added the needs-triage Indicates an issue or PR lacks a `triage/...` label and requires one. label Apr 1, 2022
@fridex
Copy link
Contributor Author

fridex commented Apr 1, 2022

/triage accepted
/sig user-experience
/sig stack-guidance

@sesheta sesheta added triage/accepted Indicates an issue or PR is ready to be actively worked on. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. sig/stack-guidance Categorizes an issue or PR as relevant to SIG Stack Guidance. and removed needs-triage Indicates an issue or PR lacks a `triage/...` label and requires one. labels Apr 1, 2022
@goern
Copy link
Member

goern commented Apr 5, 2022

👍

as this is a user-facing doc, and we would like to have one sig in the lead
/remove-sig stack-guidance

@sesheta sesheta removed the sig/stack-guidance Categorizes an issue or PR as relevant to SIG Stack Guidance. label Apr 5, 2022
@harshad16 harshad16 added documentation Improvements or additions to documentation area/documentation Issues or PRs related to documentation, tutorials, examples, ... kind/documentation Categorizes issue or PR as related to documentation. labels Apr 21, 2022
@codificat
Copy link
Member

as this is a user-facing doc, and we would like to have one sig in the lead

I agree that one SIG should lead. However, given the content of the documentation (expected to heavily rely on knowledge of how solver/advise works) I would say this should be driven by
/sig stack-guidance
rather than
/remove-sig user-experience

Also, one thing I would like to add: beyond the purely technical details, I believe the documentation should mention the requirements that packages are expected to meet: what do we accept, what not, and why.

@sesheta sesheta added sig/stack-guidance Categorizes an issue or PR as relevant to SIG Stack Guidance. and removed sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. labels May 23, 2022
@mayaCostantini mayaCostantini added sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. and removed sig/stack-guidance Categorizes an issue or PR as relevant to SIG Stack Guidance. labels Jun 27, 2022
@sesheta
Copy link
Member

sesheta commented Sep 25, 2022

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@sesheta sesheta added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 25, 2022
@harshad16
Copy link
Member

/remove-lifecycle stale
/lifecycle frozen

@sesheta sesheta added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Oct 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Issues or PRs related to documentation, tutorials, examples, ... documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Planning Board
Status: 📋 Backlog
Milestone
No milestone
Development

No branches or pull requests
6 participants
@goern @codificat @fridex @harshad16 @sesheta @mayaCostantini