search

SwissDataScienceCenter / renku

Renku provides a platform and tools for reproducible and collaborative data analysis.
https://renkulab.io
Apache License 2.0
225 stars 34 forks source link

Improve documentation on working locally #836

Open pameladelgado opened 4 years ago

pameladelgado commented 4 years ago

Is your feature request related to a problem? Please describe. Users often want to clone the gitlab project, work locally and then push their changes to a renkulab deployment. However, most of the times they are not aware that they need to setup an SSH key or their renkulab password in gitlab for the push commands to work. Moreover, it is not obvious which credentials or password to use.

Describe the solution you'd like Provide help/documentation that makes the steps needed to setup an SSH key (or password for HTTPS) clear for the users.

Describe alternatives you've considered Currently there are two alternatives: either use an SSH key which is setup just once, or use https and provide the credentials every time a pull/push is done locally. Renku could probably setup the password on Gitlab so that https works right from the start, but being prompted for credentials every time is a bit annoying.

Additional context This is inspired by some of the DSLab student questions, as well as other users encountered by @emmjab .

rokroskar commented 4 years ago

What about coming up with some way for the users to log in to the renku instance and injecting credentials into git so they don't need to worry about it? That's essentially what we do in the hosted renku notebook environments. To make it really seamless we would need some support from the gateway and/or UI but a first stab could instruct the user to go to https://renkulab.io/gitlab/profile/personal_access_tokens and paste the token into the terminal.

rokroskar commented 4 years ago

For now, the doc could just point the user to the token page and instruct them to clone with 

https://<username>:<private-token>@<renku-url>/<path-to-project>
rokroskar commented 4 years ago

btw, a very similar (easy) way can be documented for retrieving docker images that are automatically built in a project's CI.

gavin-k-lee commented 3 years ago

Does this bit of documentation solve this issue?

https://renku.readthedocs.io/en/latest/user/interactive-running-locally.html?highlight=locally#launching-the-interactive-environment-locally

rokroskar commented 3 years ago

Ah yes - it was done as a part of https://github.com/SwissDataScienceCenter/renku/issues/2043. Though I think there is still some issue with that functionality (see https://github.com/SwissDataScienceCenter/renku/pull/2043#issuecomment-812390973)