Project

Profile

Help

Issue #5998

closed

Workflow docs should better advise users they need httpie and jq

Added by daviddavis about 3 years ago. Updated over 2 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:

Description

This was feedback from Katello. If you visit a workflow page, there's no indication that you need httpie or jq. For example:

https://pulp-file.readthedocs.io/en/latest/workflows/sync.html

There is info on the workflow page:

https://pulp-file.readthedocs.io/en/latest/workflows/index.html

It might help to add a reminder to each page that links back to the workflow page and tells users to setup their env/install deps before executing the workflow examples.

Also available in: Atom PDF