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

docs: add command line full reference using sphinx-click #3065

Merged
merged 13 commits into from
Aug 15, 2022
Merged

docs: add command line full reference using sphinx-click #3065

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
acca22b
docs: add command line full reference
lorenzo-cavazzi Aug 5, 2022
46f0bc3
chore: update cheatsheet
lorenzo-cavazzi Aug 5, 2022
c5c6b3e
chore: apply suggestions from code review
lorenzo-cavazzi Aug 8, 2022
5dbe174
chore: update renku/ui/cli/clone.py
lorenzo-cavazzi Aug 8, 2022
b1d4499
docs: add clarifications on some commands
lorenzo-cavazzi Aug 8, 2022
8be4458
chore: Update cheatsheet
RenkuBot Aug 8, 2022
9e9ee1c
docs: restore missing dataset content
lorenzo-cavazzi Aug 8, 2022
181739e
chore: fix 1st grade level grammar error
lorenzo-cavazzi Aug 8, 2022
6fafd00
docs: split cli commands into multiple pages
lorenzo-cavazzi Aug 9, 2022
0638d5c
docs: test different styles
lorenzo-cavazzi Aug 10, 2022
3212e59
docs: apply common style to commands reference
lorenzo-cavazzi Aug 11, 2022
eefbb9a
Merge branch 'develop' into 3033-command-docs
lorenzo-cavazzi Aug 11, 2022
6ceee2f
chore: fix tests errors
lorenzo-cavazzi Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions renku/ui/cli/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@
Examples
~~~~~~~~

.. cheatsheet::
:group: Config
:command: $ renku config show [<key>]
:description: Show current configuration.
:extended:

You can set various Renku configuration options, for example the image registry
URL, with a command like:

Expand Down
3 changes: 3 additions & 0 deletions renku/ui/cli/mergetool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@

The merge tool is set up automatically when creating a new project or when
using ``renku clone`` to clone a Renku project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wasn't there before either, but maybe we should write something along the lines of "Merge tool configuration cannot be shared through remote repositories and has to be set up on each clone separately" ? renku clone covers it but something to let the user know that if they do a normal clone, this will be missing.

Copy link
Member Author

@lorenzo-cavazzi lorenzo-cavazzi Aug 8, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that makes sense. Otherwise, users might believe that renku clone keeps everything aligned.
I'll add a sentence, feel free to edit it if you prefer different wording.

Keep in mind the merge tool configuration cannot be shared through remote
repositories and has to be set up on each clone separately.

You can manually set up the merge tool by running ``renku mergetool install``.

Commands and options
Expand Down
2 changes: 1 addition & 1 deletion renku/ui/cli/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
Description
~~~~~~~~~~~

Visualize and edit project's metadata.
Show and edit project's metadata.

Commands and options
~~~~~~~~~~~~~~~~~~~~
Expand Down
8 changes: 5 additions & 3 deletions renku/ui/cli/remove.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@
Description
~~~~~~~~~~~

Remove a file that belongs to a dataset and update its metadata. It also
attempts to update tracking information for files stored in an external
storage (using Git LFS).
Remove a file from then project, updating:

* its metadata, if the file belong to a dataset
lorenzo-cavazzi marked this conversation as resolved.
Show resolved Hide resolved
* the tracking information, if the file is stored in an external storage
(using Git LFS).

Commands and options
~~~~~~~~~~~~~~~~~~~~
Expand Down