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.

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

The workflow docs could use some love #2901

Closed
daviddavis opened this issue Dec 2, 2022 · 3 comments
Closed

The workflow docs could use some love #2901

daviddavis opened this issue Dec 2, 2022 · 3 comments

Comments

@daviddavis
Copy link
Contributor

daviddavis commented Dec 2, 2022

I think the workflow docs have probably become out of date and thus are pretty confusing or almost unusable. To give couple examples I ran into today:

  • The upload doc doesn't mention the pulp rpm content upload command. Instead, it has users go through the painful process of creating an artifact and then a package.
  • Lots of the samples don't make sense like the pulp-cli example for creating a repo here exports a $REPO_HREF var (why?)

It's probably worth going through and revamping the docs.

@dralley
Copy link
Contributor

dralley commented Dec 2, 2022

Completely agreed

@javihernandez
Copy link
Contributor

As a 7 months-old user of pulp, I can tell that, yes, docs are confusing, specially in the beginning. You start playing with pulp, checking the docs, APIs, going back and forth to them + Postman .. kind of frustrating until you get it 😓
Also, is there an easy way to check older versions of the API on readthedocs? i.e.: we're still using 3.17 but currently online docs/API specs are for 3.19

Thanks guys!

@dralley
Copy link
Contributor

dralley commented Oct 23, 2023

I'm going to mark this as a duplicate of #2288, but copy over the specific cases called out here.

@dralley dralley closed this as not planned Won't fix, can't repro, duplicate, stale Oct 23, 2023
@pulpbot pulpbot moved this to Done in RH Pulp Kanban board Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Archived in project
Development

No branches or pull requests

3 participants