Skip to content

Commit 57c36e9

Browse files
jiangxinjiangxin
committed
review part 1,2,3.
1 parent c4a0b04 commit 57c36e9

11 files changed

Lines changed: 175 additions & 78 deletions

‎01-explore-github/010-what-is-github.rst‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _what-is-github:
22

3-
什么是GitHub
4-
================
3+
==============
4+
什么是GitHub
5+
==============
56
GitHub（网址 https://github.com/\ ）是一个面向开源及私有软件项目的托管平台，\
67
因为只支持Git作为唯一的版本库格式进行托管，故名GitHub。
78

@@ -21,7 +22,7 @@ GitHub于2008年4月10日正式发布\ [#]_\ ，相比始于1999年的SourceForg
2122

2223
对于一个开源项目，从开发角度讲大体上分为两类人群，一类称为核心开发团队，他们\
2324
可以向保存源代码的版本库提交，即对源代码的修改具有最终的决定权。另外一类称为\
24-
贡献者，他们不属于核心开发团队，虽然也能看到源代码，但只可读不可写。
25+
贡献者，他们不属于核心开发团队，虽然也能看到源代码，但无权向版本库提交修改。
2526

2627
.. _cvcs-model:
2728

@@ -39,8 +40,8 @@ GitHub于2008年4月10日正式发布\ [#]_\ ，相比始于1999年的SourceForg
3940

4041
.. _dvcs-model:
4142

42-
Git等分布式版本控制系统的出现，彻底颠覆了原有代码管理的管理模式。使用Git，\
43-
不再需要唯一的、集中式的版本库，而是每个开发者本地都拥有一份完整的版本库。\
43+
Git等分布式版本控制系统的出现，彻底颠覆了原有代码管理的组织模式。使用Git，\
44+
不再依赖唯一的、集中式的版本库，而是每个开发者本地都拥有一份完整的版本库。\
4445
Git并不排斥集中式的使用模式，但更倾向于将集中式版本库称为共享版本库。核心\
4546
开发团队的成员和贡献者（非核心成员）都可以从共享版本库克隆一份本地版本库，\
4647
但只有核心团队成员才可以将自己本地版本库的提交推送到共享版本库上。\
@@ -63,22 +64,23 @@ Git并不排斥集中式的使用模式，但更倾向于将集中式版本库
6364

6465
.. _github-model:
6566

66-
GitHub的出现极大地改善了开源项目的生态环境，无论是项目的核心开发团队，还是\
67-
普通的项目贡献者都工作得非常“愉快”。创建项目变得非常轻松，创建者只需在GitHub\
68-
上点击一下鼠标即可创建一个新版本库，组建项目核心团队也很容易。核心团队使用\
69-
Git命令操作共享版本库，如图1-4所示。
67+
GitHub的出现进一步推动了Git的普及，简化了版本控制的管理和操作流程，为开发者\
68+
提供了更好的交流平台。如图1-4所示。
7069

7170
.. figure:: /images/explore-github/github-model.png
7271
:scale: 100
7372

7473
图1-4：GitHub的协同模式
7574

76-
在GitHub中，非核心团队成员参与项目也很容易。先找到自己希望参与的项目，然后\
77-
只需在Web上点击一下鼠标即可在自己的托管空间下创建一个派生（fork）的项目，\
75+
使用GitHub，无论是项目的核心开发团队，还是普通的项目贡献者都工作得非常“愉快”。\
76+
创建项目变得非常轻松，创建者只需在GitHub上点击一下鼠标即可创建一个新版本库，\
77+
通过简单的Web操作即可完成项目授权进而组建项目核心团队。在GitHub中，\
78+
非核心团队成员参与项目也很容易。先找到自己希望参与的项目，然后只需在Web\
79+
上点击一下鼠标即可在自己的托管空间下创建一个派生（fork）的项目，\
7880
并对派生项目的版本库具有读写的完全权限，就好像这个项目原本就是由自己创立的\
7981
那样。当贡献者完成开发并向自己派生的版本库推送后，可以通过GitHub的Web界面向\
8082
项目的核心开发团队发送一个Pull Request，请求审核。项目的核心团队收到\
81-
Pull Request后审核代码，审核通过后可以直接通过Web界面完成合并。
83+
Pull Request后审核代码，审核通过后可以直接通过Web界面执行合并操作接纳贡献者的提交。
8284

8385
----
8486

‎01-explore-github/020-github-hightlights.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ GitHub亮点
2525

2626
3. 无处不在的Git。
2727

28-
除了在版本库托管上使用Git，Git还被应用到GitHub更多的领域。维基使用Git，\
28+
除了在版本库托管上使用Git，Git还被GitHub应用到更多领域。维基使用Git，\
2929
可以通过克隆维基所在的版本库，离线修改维基；在线粘贴数据的Gist网站\ [#]_\
3030
使用Git，记录变更历史；以及在Jekyll应用的帮助下，用Git版本库维护个人网站\
3131
和博客等。
@@ -57,5 +57,5 @@ GitHub亮点
5757
----
5858

5959
.. [#] 实际上使用HTTP协议也可以免口令输入。即通过文件\ ``~/.netrc``\ 写入\
60-
HTTP认证的明文口令，具体文件格式参见\ ``ftp``\ 命令的MAN手册中相关介绍。
60+
HTTP认证的明文口令。具体文件格式参见\ ``ftp``\ 命令MAN手册中相关介绍。
6161
.. [#] https://gist.github.com/

‎01-explore-github/030-explore-github.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
探索GitHub
44
===============
55

6-
打开浏览器，访问网址 https://github.com/ 来探索GitHub吧。GitHub的首页\
6+
打开浏览器，访问网址 https://github.com/\ ，来探索GitHub吧。GitHub的首页\
77
（图1-5所示）特意给出了Git和GitHub的音标，可能不少国人需要据此校准一下\
88
Git的读音\ [#]_\ 。
99

@@ -34,8 +34,8 @@ Git的读音\ [#]_\ 。
3434

3535
图1-7：热门版本库排行
3636

37-
图1-8显示了托管版本库所用编程语言的动态分布，多掌握几个热门编程语言一定会对\
38-
找工作有帮助。;-)
37+
图1-8显示了托管版本库所用编程语言的动态分布，程序员多掌握几个热门编程语言\
38+
一定会对找工作有帮助。;-)
3939

4040
.. figure:: /images/explore-github/explore-languages.png
4141
:scale: 100

‎02-join-github/010-account-setup.rst‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,20 @@ GitHub的注册页面非常简洁，只有登录ID，邮件地址和口令需要
2727
每个邮件地址只能注册一次。
2828

2929
注册完毕即以新注册的账号自动登录。登录后即进入用户的仪表板（Dashborad）\
30-
页面，如果图2-3所示。
30+
页面。首次进入的仪表板页面还会在其中显示GitHub BootCamp（GitHub 新手训练营）\
31+
的链接，以帮助新用户快速入门。如果图2-3所示。
3132

3233
.. figure:: /images/join-github/loggedin.png
3334
:scale: 100
3435

3536
图2-3：登录后的GitHub首页
3637

37-
仪表板页面是用户最重要的页面，创建新项目（新版本库）的链接就位于该页面。\
38-
页面左上角的“github”文字图标实际可以点击，是进入仪表板页面的快捷。
38+
仪表板页面是用户最重要的页面，因为创建新项目（新版本库）的链接就位于该页面。\
39+
重新设计的GitHub用户界面\ [#]_\ 中跳转到仪表板页面的链接不像之前那么直观，\
40+
鼠标移动到页面左上角的“github”文字图标会发现此图标可以点击，该文字图标即是\
41+
进入仪表板页面的快捷。
3942

40-
页面右上方显示当前登录用户的名称和头像。图2-3中显示登录用户为 gotgithub，\
43+
在页面右上方显示当前登录用户的名称和头像。图2-3中显示登录用户为 gotgithub，\
4144
而用户头像因为尚未设置所以显示为缺省图片——GitHub吉祥物Octocat的剪影。在页面\
4245
右上方还有三个图标，从左至右分别是：通知、账号设置和退出。点击账号设置图标\
4346
对账号进行进一步设置，如图2-4所示。
@@ -128,7 +131,7 @@ GitHub的SSH服务支持OpenSSH格式的公钥认证，可以通过Linux、Mac O
128131

129132
$ ssh-keygen -C "[email protected]" -f ~/.ssh/gotgithub
130133

131-
当生成的公钥/私钥对不在缺省位置（~/.ssh/id_rsa等）时，使用\ ``ssh``\ 命令\
134+
当生成的公钥/私钥对不在缺省位置（\ ``~/.ssh/id_rsa``\ 等）时，使用\ ``ssh``\ 命令\
132135
连接远程主机时需要使用参数\ ``-i <filename>``\ 指定公钥/私钥对。或者在配置\
133136
文件\ ``~/.ssh/config``\ 中针对相应主机进行设定。例如对于上例创建了非缺省\
134137
公钥/私钥对\ ``~/.ssh/gotgithub``\ ，可以在\ ``~/.ssh/config``\ 配置文件中\
@@ -142,7 +145,7 @@ GitHub的SSH服务支持OpenSSH格式的公钥认证，可以通过Linux、Mac O
142145
PreferredAuthentications publickey
143146
IdentityFile ~/.ssh/gotgithub
144147

145-
好了，有了上面的准备，就将 :file:`~/.ssh/gotgithub.pub` 文件内容拷贝到剪切板。\
148+
好了，有了上面的准备，就将\ :file:`~/.ssh/gotgithub.pub`\ 文件内容拷贝到剪切板。\
146149
在命令行用下面的命令可直接将文件内容拷贝到剪切板：
147150

148151
::
@@ -151,14 +154,14 @@ GitHub的SSH服务支持OpenSSH格式的公钥认证，可以通过Linux、Mac O
151154

152155

153156
然后将公钥文件中的内容粘贴到GitHub的SSH公钥管理的对话框中，如图2-8所示。\
154-
注意整个公钥为一行，不要断行。
157+
注意要忠实地拷贝公钥的内容，切莫在其中插入多余的换行符、空格而导致认证失败。
155158

156159
.. figure:: /images/join-github/setting-ssh-gotgithub.png
157160
:scale: 100
158161

159162
图2-8：添加SSH公钥认证
160163

161-
设置成功后，再用\ ``ssh``\ 命令访问 github.com，会显示一条认证成功信息并退出。\
164+
设置成功后，再用\ ``ssh``\ 命令访问GitHub，会显示一条认证成功信息并退出。\
162165
在认证成功的信息中还会显示该公钥对应的用户名。
163166

164167
::
@@ -167,7 +170,8 @@ GitHub的SSH服务支持OpenSSH格式的公钥认证，可以通过Linux、Mac O
167170
Hi gotgithub! You've successfully authenticated, but GitHub does not provide shell access.
168171

169172
如果您未能看到类似的成功信息，可以通过在\ ``ssh``\ 命令后面添加\ ``-v``\ 参数\
170-
加以诊断，会在冗长的会话中看到认证所使用的公钥文件等信息。
173+
加以诊断，会在冗长的会话中看到认证所使用的公钥文件等信息。然后比对所使用的公钥\
174+
内容是否和GitHub账号中设置的相一致。
171175

172176
::
173177

@@ -183,11 +187,13 @@ GitHub的SSH服务支持OpenSSH格式的公钥认证，可以通过Linux、Mac O
183187

184188
账号设置的最后一项是向GitHub提供你的求职信息。GitHub作为一个优秀程序员的聚集地，\
185189
已成为一个IT人才招聘的途径，如果你需要找工作的话，提供简历并打开“Available for hire”\
186-
选项，如图2-9所示。
190+
选项，GitHub会向你推荐合适的工作机会。如图2-9所示。
187191

188192
.. figure:: /images/join-github/setting-job.png
189193
:scale: 100
190194

191195
图2-9：求职信息管理
192196

193197
.. _gravatar.com: http://gravatar.com/
198+
199+
.. [#] https://github.com/blog/1007-skinny-header

‎02-join-github/020-browse-repo.rst‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
浏览托管项目
44
===============
55

6-
GitHub的账户已经建立好了，在建立自己的项目托管之前，看看别人是怎么做的。在\
7-
GitHub中搜索字符串“GotGit”，可以搜索到我建立的一个项目，项目地址是：\
6+
在上一节学习了如何建立GitHub的账户，接下来在建立自己的项目托管之前，\
7+
先来看看别人是怎么做的。
8+
9+
在GitHub中搜索字符串“GotGit”，可以搜索到我建立的一个项目，项目地址是：\
810
https://github.com/gotgit/gotgit/\ 。\
911
由上至下，GotGit项目首页可以分为如下几个区域。
1012

@@ -35,9 +37,9 @@ https://github.com/gotgit/gotgit/\ 。\
3537

3638
* 区域二：代码浏览子菜单及分支切换对话框。
3739

38-
默认项目代码页（即项目首页）显示项目文件列表（即\ ``Files``\ 子菜单）。在\
39-
图2-11的右侧还显示了项目\ ``gotgit/gotgit``\ 默认的分支为\ ``gh-pages``\
40-
而非常见的\ ``master``\ 分支。关于\ ``gh-pages``\ 分支，在“第3.5节 建立主页”\
40+
默认项目代码页（即项目首页）显示项目文件列表（即\ ``Files``\ 子菜单），如\
41+
图2-11所示。右侧还显示项目\ ``gotgit/gotgit``\ 默认的分支为\ ``gh-pages``\
42+
而非常见的\ ``master``\ 分支。关于\ ``gh-pages``\ 分支，在“第3.5.2节 :ref:`project-homepage`\ ”\
4143
会介绍该分支的神奇用途。
4244

4345
.. figure:: /images/join-github/gotgit-repo-tree-1-submenu.png

‎02-join-github/030-be-social.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ RSS中可能包括隐私信息，如私有版本库的更新信息，那么RSS
4747

4848
https://github.com/gotgithub.private.atom?token=681a8a5a38419ecfb80f8633d4cb4e16
4949

50-
原来RSS订阅用到了API Token，既保护了隐私，又不怕密码泄露。关于API Token参见本章\
51-
第一节的相关介绍。
50+
原来RSS订阅用到了API Token进行身份认证，即保障了个人RSS的私密性，又避免直接\
51+
使用明文口令导致的密码泄露。关于API Token，参见本章\ :ref:`第2.1节中相关介绍 <api-token>`\ 。

‎03-project-hosting/010-new-project.rst‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
在GitHub，一个项目对应唯一的Git版本库，创建一个新的版本库就是创建一个新的项目。\
1212
访问仪表板（Dashboard）页面，如图3-1，可以看到关注的版本库中已经有一个，\
1313
但自己的版本库为零。在显示为零的版本库列表面板中有一个按钮“New Repository”，\
14-
点击该按钮。
14+
点击该按钮开始创建新版本库。
1515

1616
.. figure:: /images/project-hosting/new-repo-btn.png
1717
:scale: 100
@@ -25,8 +25,8 @@
2525

2626
图3-2：创建新项目
2727

28-
GitHub中，每个项目都对应于唯一的Git版本库，所以创建项目即是创建版本库，\
29-
反之亦然。我们创建的新项目名为“helloworld”，创建完毕后访问项目页，提示版本库\
28+
我们为新建立的版本库命名为“helloworld”，\
29+
相应的项目名亦为“helloworld”，创建完毕后访问项目页，提示版本库\
3030
尚未初始化，并给出如何初始化版本库的帮助，如图3-3所示。
3131

3232
.. figure:: /images/project-hosting/project-uninitial.png
@@ -36,7 +36,7 @@ GitHub中，每个项目都对应于唯一的Git版本库，所以创建项目
3636

3737
在图3-3中可以看到访问协议增加了一个支持读写的SSH协议，访问地址为：\
3838
``[email protected]:gotgithub/helloworld.git``\ 。注意任何GitHub用户均可使用该\
39-
URL访问此公开版本库，但只有版本库建立者\ `gotgithub`\ 具有读写权限，其他人\
39+
URL访问此公开版本库，但只有版本库建立者gotgithub具有读写权限，其他人\
4040
只有只读权限。在初始化版本库之前，最好先确认是否是用正确的公钥进行认证，如下：
4141

4242
::
@@ -132,11 +132,12 @@ URL访问此公开版本库，但只有版本库建立者\ `gotgithub`\ 具有
132132
从已有版本库创建
133133
-----------------
134134

135-
如果在GitHub项目创建之前版本库就已经存在，显然像上面那样先克隆、再提交、\
136-
后推送的方法就不适宜了。应该采用下面的方法。
135+
如果在GitHub项目初始化之前，数据已经存在于本地版本库中，显然像上面那样先克隆、\
136+
再提交、后推送的方法就不适宜了。应该采用下面的方法。
137137

138-
在试验新方法初始化版本库之前，先删除再重建\ `helloworld`\ 项目。注意：删除\
139-
项目操作非常危险，不可恢复，慎用。
138+
为试验新的版本库初始化方法，先把刚刚新建的测试项目“helloworld”删除，\
139+
同时也将本地工作区中克隆的“helloworld”删除。\
140+
警告：删除项目的操作非常危险，不可恢复，慎用。
140141

141142
* 点击项目首页中项目名称旁边的“Admin”按钮进入项目管理页，再点击页面最下方的\
142143
删除版本按钮，如图3-6所示。
@@ -146,9 +147,9 @@ URL访问此公开版本库，但只有版本库建立者\ `gotgithub`\ 具有
146147

147148
图3-6：删除项目
148149

149-
* 然后再重建项目，如本章一开始图3-2所示。
150+
* 然后再重建版本库“helloworld”，如本章一开始图3-2所示。
150151

151-
接下来使用下面的步骤完成\ `helloworld`\ 版本库的初始化。
152+
接下来使用下面的步骤完成“helloworld”版本库的初始化。
152153

153154
* 本地建立一个Git版本库。
154155

@@ -172,7 +173,7 @@ URL访问此公开版本库，但只有版本库建立者\ `gotgithub`\ 具有
172173
$ git remote add origin [email protected]:gotgithub/helloworld.git
173174

174175
* 执行推送命令，完成GitHub版本库的初始化。注意命令行中的\ ``-u``\ 参数，在推送\
175-
成功后自动建立本地分支和远程分支的跟踪。
176+
成功后自动建立本地分支与远程版本库分支的追踪。
176177

177178
::
178179

0 commit comments

Comments
 (0)