-
Notifications
You must be signed in to change notification settings - Fork 2k
Create atom.asc #1144
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create atom.asc #1144
Conversation
Atom is a fairly popular IDE that fully integrates with Git. This provides rudimentary explanation on how to set up Git integration with non github remote repositories from within a windows environment. When I set up my environment, having access to these few lines would have saved me hours of googling...
|
||
Another way is from the menu: `Packages -> GitHub -> Toggle Git Tab` | ||
|
||
GitHub comes with plenty of documentation when it comes to the integration with a remote repository on GitHub, which you can find within atom "Flight Manual". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rationale for change:
- Atom is a noun and so needs to be capitalized.
- Also we need a 's to indicate possession. Whose flight manual is it? It is Atom's Flight Manual.
Suggested situation after implementing changes:
GitHub comes with plenty of documentation when it comes to the integration with a remote repository on GitHub, which you can find within Atom's "Flight Manual".
ssh://[email protected]:portNB/path/project.git | ||
|
||
For this operation to succeed, make sure that your git and your ssh are properly configured. | ||
Git is configured from a file called `.gitconfig` which must be located in your user directory (`%USERPROFILE%` on windows, run `git config` on Linux environments). Similarly SSH must be configured in a file `/.ssh/config` also located within your user directory on windows environement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rationale for change:
- The word "Windows" is a noun, it refers to a specific thing, so it needs to be capitalized.
- The spelling for the word environement is wrong, it is: environment.
Suggested situation after implementing changes:
For this operation to succeed, make sure that your git and your ssh are properly configured.
Git is configured from a file called .gitconfig
which must be located in your user directory (%USERPROFILE%
on Windows, run git config
on Linux environments). Similarly SSH must be configured in a file /.ssh/config
also located within your user directory on Windows environment.
I am not convinced of the relevance of this addition. All information needed for the GitHub package for Atom may be found at https://flight-manual.atom.io/using-atom/sections/github-package/, correct configuration of SSH is a classic and what is said about .gitconfig is not an information because it is something we already know. |
@aollier This PR was a starting point. The Appendix A: "Git in other environment" contains two big IDE (Eclipse and VS), with the growing popularity of Atom some extra info could be helpful to beginners. I know that as a git beginner myself I went looking for info on git-scm and I could not find it. If it is not relevant then of course remove it :). |
@G-T-P I think that if this information may be useful, its place is in Atom's or GitHub package's documentation. From my point of view, only parts Graphical Interfaces and Git in Bash have their place in the Appendix A. For instance, the section about Visual Studio is already out-of-date since the link takes us to Microsoft's "Azure Repos". I don't want to spend time to get the information in Git in Visual Studio up-to-date since it may still progress and Microsoft already provides information to interact with Git. |
Even if this goes against my PR, this is a very valid point. Additionally it cannot be expected from git-scm to list all possible IDEs which include git natively or through plugins. I am just someone who wants to help, in the end though the call is yours/@ben. |
Thanks anyway for help! 😄 |
I wrestled with whether to accept this or not. The overall goal with including editor-specific content in the first place is that the book aims to be useful. It seemed likely 5 years ago that a user who is new to Git was likely to be working in something like Visual Studio or Eclipse. However, there's a long tail of other editors with Git integrations, and it's probable that the majority of users are not using VS or Eclipse. Indeed, the SO Survey last year found that Notepad++ and Vim were more popular than Eclipse. I see an argument for including all editors who want to be here, since we want to be useful, but that's a ton of work. I also see an argument for removing all the editor-specific content altogether, since we don't want to be out-of-date. In the end, for the sake of cohesiveness and continuing quality, we have to be selective in which editors we have sections for. I'm going to close this PR, and set up an issue with the editors we do want to support. @G-T-P, thanks for your contribution. Even though we're not accepting these specific changes, you've contributed to making the book a better resource for the community! |
Atom is a fairly popular IDE that fully integrates with Git. This provides rudimentary explanation on how to set up Git integration with non github remote repositories from within a windows environment.
When I set up my environment, having access to these few lines would have saved me hours of googling...