-
Notifications
You must be signed in to change notification settings - Fork 115
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
Provide general feature and workflow matrix for plugins #5593
Comments
I do have an issue with the intent here. As history has shown to me, such a feature matrix is created by hand by one individual, because there is no way to automate it. And this individual will put a lot of effort in it and make it very accurate that that point in time. Maybe a group of people even agrees to care about it and keep it up to date. But the reality is, it will get out of date and the more outdated, the harder it gets to update again. This is like balancing a broomstick on your nose. Eventually it will fall on the floor. |
I do not disagree it will eventually get outdated, but I dont think this is a reason not to do it.
Are you suggesting we do other features machine-readable? Anyway, personally I would like to have such a listing specially on the workflows, which is a more high level and readily useful concept. |
That is exactly the reason not to do it.
Yes, at least think about it. |
Posting here for reference, because I liked how each feature is tied to a docs-link: https://www.postgresql.org/about/featurematrix/ |
While fixing some links in pulp-oci-images, I've came across a reference to "Workflows and Use Cases", which was a set of pages on pulpcore legacy docs. On docs migration, while moving some of these pages, we didnt preserve the notion of a workflow in pulpcore docs.
If I was reading the pulp-oci-images and got to this point (the link is in a section called "Try out a workflow"), I would expect to go to a page with small descriptions of some workflows and links to concrete plugin-implementation for them. And possibly a matrix table, similar to the matrix request for dependencies (#5573), but maybe a little harder to automate.
Problem
No definitive reference for available features and workflows across plugins.
Initial Approach
What I see as possible first steps are:
As a starting point, I tried to organize the titles mentioned in the "Workflow and Use Cases" page linked above.
Further steps
Having a compreehensive list of that, we can:
E.g: each plugin repository can contain a feature-set manifesto which is used by pulp-docs to generate the matrix.
This manifesto can include things like tech-preview status, version info (included, modified and deprecated), etc.
The text was updated successfully, but these errors were encountered: