Version Control Tutorial various comments

[david-lippert]

Various comments from my review of the content

• Do we want to have the same scope as the licensing tutorial to help limit & narrow the content? Specifically do we want to add "for Researchers and Educators"?
• In the Open Source Software section, the presentation does not have any context provided. Is it redundant or meant to provide more details? I like it, but it feels like it is floating here and I'm not sure about the purpose of including it and highlighting it by putting it first.
• In the Why Open Source section, if you focus on researchers and educators, then you could add something about citations and specifically it might be nice to encourage people to put a CITATION.cff file in their github repos.
• Another important addition to the "Why Open Source" section is that you will not lose access to your code when you move to a new organization or company.
• I'm not sure if this belongs in the "How to Open Source" section or later in the tutorial, but I love the repo-scaffolder as a guide to which files you should include in your project depending on it's maturity.
• At the end of the "Version Control Overview" section is it enough to have the Terminology section or do you need more details about these concepts?
• In the Gitub section or before do you need to explain the difference between git and GitHub (technology versus implementation)
• Is Github desktop necessary or is github through the browser fine (what are the differences if any)?
• Do we need to explain github enterprise and about creating orgs and whether to attach to the enterprise or keep separate?

[s2t2]

Thanks @david-lippert for these comments! See my responses below. Feel free to follow up as desired.

Sub-issue 1.1:

• Do we want to have the same scope as the licensing tutorial to help limit & narrow the content? Specifically do we want to add "for Researchers and Educators"?

The content seems broader, applying to all software developers in general. Also we don't really mention education use cases. However we can add researcher-specific content in certain areas (for example the below suggestion 1.3 regarding the CITATION.cff file)

Sub-issue 1.2:

• In the Open Source Software section, the presentation does not have any context provided. Is it redundant or meant to provide more details? I like it, but it feels like it is floating here and I'm not sure about the purpose of including it and highlighting it by putting it first.

Yes, I agree. I tried to present the content as a textual summary of the presentation. Maybe we can add a sentence that says something like "The content of this presentation is narrated below". Otherwise I am not sure what to do with the presentation other than remove it. If you have any thoughts or suggestions, let me know.

Sub-issue 1.3:

• In the Why Open Source section, if you focus on researchers and educators, then you could add something about citations and specifically it might be nice to encourage people to put a CITATION.cff file in their github repos.

Awesome suggestion. I will incorporate this, perhaps under a new section of "Why Open Source > Increase Visibility" along with some other content there. Really great idea. Thank you.

Sub-issue 1.4:

• Another important addition to the "Why Open Source" section is that you will not lose access to your code when you move to a new organization or company.

Good point. I will incorporate this.

Sub-issue 1.5:

• I'm not sure if this belongs in the "How to Open Source" section or later in the tutorial, but I love the repo-scaffolder as a guide to which files you should include in your project depending on it's maturity.

OK I am unfamiliar with this, but I will take a look and see how to incorporate it. Will get back to you.

Sub-issue 1.6:

• At the end of the "Version Control Overview" section is it enough to have the Terminology section or do you need more details about these concepts?

I can try to add some more context about each of the concepts. Or link to more information from the Git / GitHub documentation.

UPDATE: there is already a link to official documentation to learn more. Not sure how much more context can be added here. Will add a sentence mentioning that "readers can get more familiar with each of these concepts by following the exercises".

Sub-issue 1.7:

• In the Gitub section or before do you need to explain the difference between git and GitHub (technology versus implementation)

Good suggestion, as this can be confusing, especially for beginners. I will try to make the contrast more explicit.

Sub-issue 1.8:

• Is Github desktop necessary or is github through the browser fine (what are the differences if any)?

Definitely necessary for editing and committing multiple files at a time. Although the new codespaces feature is trying to be an in-browser replacement. I will mention some options and contrast them and then recommend GitHub Desktop software. Also all the exercise walkthrough videos use GitHub Desktop 😄

Sub-issue 1.9:

• Do we need to explain github enterprise and about creating orgs and whether to attach to the enterprise or keep separate?

I don't have much experience with this, and would appreciate recommendations and guidance.