making code/git document more beginner friendly

Bug #2058510 reported by Eylul
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Launchpad itself
Confirmed
Low
Unassigned

Bug Description

I have recently went through using the https://help.launchpad.net/Code/Git document as a flavor volunteer. Overall it was very helpful but ran an minor issue:

The document assumes the user has previously used git commandline for other projects and systems.

These two changes to the "Configuring Git" would help preventing greatly to prevent a new user from getting stuck.

1) Mentioning of creating global username and email for the gitconfig
2) link to the https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair document as steps to complete.

Revision history for this message
Jürgen Gmach (jugmac00) wrote :

Thanks for the suggestions.

Do you have an idea where we should add the information? I am happy to update the document.

Revision history for this message
Eylul (eylul) wrote (last edit ):

I think right at the beginning of the "configuring Git" section makes sense the most., As a new user, I probably should have gone in order of SSH key and global name/email, and adding the abbreviations after getting that first part to work.

for example:

"If you are a first time git user, or you have never used git from commandline before. You'll need to your global username and email to be able to commit changes".... etc this might be just a mention or a quick list of commands to use.

then

To be able to securely download and push commits you will need to have an SSH Key set in your system, and uploaded to your launchpad." then the link or something along those lines.

then continues with the existing content that starts with "Git identifies repositories using URLs. Unlike Bazaar,"

Thanks very much for looking into this. :)

Guruprasad (lgp171188)
Changed in launchpad:
status: New → Confirmed
importance: Undecided → Low
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.