nisystemsengineering/github-hands-on

github-hands-on's Issues

LabVIEW Diff setup

It'd be great to document how to set up lvdiff to have it work locally.

Nomenclature discussion

During the hands-on there are quite a few concepts being introduced such as Fetching, Pulling, Merging, etc.

Do we want to go through the basic definitions of Fetching, Merging, Pulling, etc? For example, mentioning that a Pull is a Fetch followed by a Merge, or that it could be a Fetch followed by a Rebase.

Relative-Path Images on GitHub

Despite images referenced by relative path showing up in preview in browser using Sublime plugins (see Issue #4 ), they are still not showing up in the GitHub view.

Branching referenced before it's taught

Looking at section 1.6 on fetching and pulling, it gets you to change the readme.md and then note that we're working tine ht Third-Sum-Edit branch. Branching isn't covered until section 1.8

Preview Relative-Path Markdown Images

Don't really need to make an issue for this, I suppose, but thought it would be good to document. @tannerblair and I already talked about this: Do we have a good way to preview Markdown that pulls images with relative paths?

Ex: 

Finish v0 rough draft

Clarity & Syntax

Overall really clear and walks through everything you need to be proficient! Minor points of feedback:

• In Section 1.1, point 1., the file menu says New Repository rather than Create New Repository. People will probably figure it out but it's not 100% clear. Also, for consistency throughout the document, the sentence should end with a period.

• In Section 1.1, point 2. section v., the action that the user should take could be clearer. I'd start out with: "Select LabVIEW in the git ignore dropdown" and then explain the context like you've already done.

• In Section 1.9, point 3, there's a typo. Says "int he", should be "in the".

Incorporate More Advanced LabVIEW-Specific Info

There is more LabVIEW-specific info that I have not added yet, for example:

• Separate compiled code from project and the weirdness this can prevent
• Why and how to avoid merges: subVIs, communication with your dev team, tracking with Issues

This may be information overload to introduce when the user is still trying to learn the basic concepts of source control like committing, branches, and multiple Git servers. I think it may be best to put it at the end in a sort of "LabVIEW best practices with Git" sort of section after they have grasped the basic Git concepts.

@becega