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

docs: Reference CLI API #104

Closed
tiborsimko opened this issue Jan 13, 2022 · 0 comments · Fixed by #106 or reanahub/reana-client#586
Closed

docs: Reference CLI API #104

tiborsimko opened this issue Jan 13, 2022 · 0 comments · Fixed by #106 or reanahub/reana-client#586
Assignees

Comments

@tiborsimko
Copy link
Member

Check page https://docs.reana.io/reference/reana-client-cli-api/

E.g. info command is missing there.

We should update this page to latest version.

We might also consider leaving the body mostly empty and simply link to the RTFD web site for details, as we are doing for Python API. However, this has a disadvantage of users searching for some concept and not finding anything on docs.reana.io, so we should be careful here. Perhaps we can consider this later, after we populate tutorial parts (#26) which will touch many of these commands. Still, an auto-generated reference guide might be of interest.

@mvidalgarcia mvidalgarcia self-assigned this Jan 14, 2022
mvidalgarcia added a commit to mvidalgarcia/docs.reana.io that referenced this issue Jan 17, 2022
mvidalgarcia added a commit to mvidalgarcia/docs.reana.io that referenced this issue Jan 17, 2022
- Add missing `info` command
- Use double ticks everywhere so expressions are compatible with
both markdown (docs.reana.io) and reStructuredText (reana-client.readthedocs.io)

closes reanahub#104
mvidalgarcia added a commit to mvidalgarcia/docs.reana.io that referenced this issue Jan 17, 2022
- Add missing `info` command
- Use double backticks everywhere so highlighted expressions are compatible with
both markdown (docs.reana.io) and reStructuredText (reana-client.readthedocs.io)

closes reanahub#104
mvidalgarcia added a commit to mvidalgarcia/docs.reana.io that referenced this issue Jan 17, 2022
- Add missing `info` command
- Use double backticks everywhere so highlighted expressions are compatible with
both markdown (docs.reana.io) and reStructuredText (reana-client.readthedocs.io)

closes reanahub#104
mvidalgarcia added a commit to mvidalgarcia/reana-client that referenced this issue Jan 17, 2022
mvidalgarcia added a commit to mvidalgarcia/reana-client that referenced this issue Jan 17, 2022
mvidalgarcia added a commit to mvidalgarcia/reana-client that referenced this issue Jan 17, 2022
mvidalgarcia added a commit to mvidalgarcia/reana-client that referenced this issue Jan 17, 2022
mvidalgarcia added a commit to mvidalgarcia/reana-client that referenced this issue Jan 17, 2022
mvidalgarcia added a commit to mvidalgarcia/reana-client that referenced this issue Jan 17, 2022
@mvidalgarcia mvidalgarcia reopened this Jan 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants