nebari-dev / nebari-dev/nebari-docs

[DOC] - Add details on using git in code-server

Open
#486 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: documentation 📖 area: user experience 👩🏻‍💻
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Preliminary Checks
Summary

The VSCode git extension works but there are some nuances about using it within Nebari that may be helpful to know.

Cloning a git repository

If you've never been to VSCode on Nebari before, you'll get the "Welcome Screen". This is the view of the welcome screen on a first login after clicking the git extension on the left sidebar":
image

From here, you can "Clone Respository" either through the extension panel on the left OR through the Welcome Screen UI on the right.

Its worth noting that the above workflow is only available on first login since Nebari will remember your previous workspace and will open it instead of the Welcome Screen. You can either get a clean workspace by going to "File" -> "New Window", or try the alternative below.

The other alternative is to go "View" menu -> "Command Pallette" and search for the "Git: Clone" option.
image

This will allow you to clone an external git repository:
image

After cloning the repositories will appear in the extension UI on the left:
image

GitHub login

If you select the option to "Clone from GitHub" you'll be given an opportunity to authenticate to GitHub which will allow you to pull private repos. I was able to go through that process succesfully.

GPG keys

The documentation on the git extension indicates that GPG keys can be used, but I ran into errors with that process. That will need more investigation.

Steps to Resolve this Issue

.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the code-server documentation section covering Git use in Nebari and compare it with the cloning, GitHub login, and GPG key details in this issue. Document the available cloning workflows and GitHub authentication, and clearly mark the GPG key behavior as needing further investigation if it remains unresolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, vscode
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.