Skip to content

Commit c10ec9a

Browse files
authored
Merge pull request #1848 from petk/patch-images
Sync image alt descriptions with captions
2 parents 8be33dd + 08529ae commit c10ec9a

File tree

10 files changed

+52
-52
lines changed

10 files changed

+52
-52
lines changed

book/01-introduction/sections/about-version-control.asc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It is easy to forget which directory you're in and accidentally write to the wro
1919

2020
To deal with this issue, programmers long ago developed local VCSs that had a simple database that kept all the changes to files under revision control.
2121

22-
.Local version control
22+
.Local version control diagram
2323
image::images/local.png[Local version control diagram]
2424

2525
One of the most popular VCS tools was a system called RCS, which is still distributed with many computers today.
@@ -33,7 +33,7 @@ To deal with this problem, Centralized Version Control Systems (CVCSs) were deve
3333
These systems (such as CVS, Subversion, and Perforce) have a single server that contains all the versioned files, and a number of clients that check out files from that central place. (((CVS)))(((Subversion)))(((Perforce)))
3434
For many years, this has been the standard for version control.
3535

36-
.Centralized version control
36+
.Centralized version control diagram
3737
image::images/centralized.png[Centralized version control diagram]
3838

3939
This setup offers many advantages, especially over local VCSs.
@@ -54,7 +54,7 @@ In a DVCS (such as Git, Mercurial, Bazaar or Darcs), clients don't just check ou
5454
Thus, if any server dies, and these systems were collaborating via that server, any of the client repositories can be copied back up to the server to restore it.
5555
Every clone is really a full backup of all the data.
5656

57-
.Distributed version control
57+
.Distributed version control diagram
5858
image::images/distributed.png[Distributed version control diagram]
5959

6060
Furthermore, many of these systems deal pretty well with having several remote repositories they can work with, so you can collaborate with different groups of people in different ways simultaneously within the same project.

book/01-introduction/sections/installing.asc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ If you don't have it installed already, it will prompt you to install it.
4848
If you want a more up to date version, you can also install it via a binary installer.
4949
A macOS Git installer is maintained and available for download at the Git website, at https://git-scm.com/download/mac[^].
5050

51-
.Git macOS Installer
51+
.Git macOS installer
5252
image::images/git-osx-installer.png[Git macOS installer]
5353

5454
==== Installing on Windows

book/01-introduction/sections/what-is-git.asc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Git has three main states that your files can reside in: _modified_, _staged_, a
8686
This leads us to the three main sections of a Git project: the working tree, the staging area, and the Git directory.
8787

8888
.Working tree, staging area, and Git directory
89-
image::images/areas.png["Working tree, staging area, and Git directory."]
89+
image::images/areas.png["Working tree, staging area, and Git directory"]
9090

9191
The working tree is a single checkout of one version of the project.
9292
These files are pulled out of the compressed database in the Git directory and placed on disk for you to use or modify.

book/03-git-branching/sections/rebasing.asc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,20 +151,20 @@ Suppose you clone from a central server and then do some work off that.
151151
Your commit history looks like this:
152152

153153
.Clone a repository, and base some work on it
154-
image::images/perils-of-rebasing-1.png["Clone a repository, and base some work on it."]
154+
image::images/perils-of-rebasing-1.png["Clone a repository, and base some work on it"]
155155

156156
Now, someone else does more work that includes a merge, and pushes that work to the central server.
157157
You fetch it and merge the new remote branch into your work, making your history look something like this:
158158

159159
.Fetch more commits, and merge them into your work
160-
image::images/perils-of-rebasing-2.png["Fetch more commits, and merge them into your work."]
160+
image::images/perils-of-rebasing-2.png["Fetch more commits, and merge them into your work"]
161161

162162
Next, the person who pushed the merged work decides to go back and rebase their work instead; they do a `git push --force` to overwrite the history on the server.
163163
You then fetch from that server, bringing down the new commits.
164164

165165
[[_pre_merge_rebase_work]]
166166
.Someone pushes rebased commits, abandoning commits you've based your work on
167-
image::images/perils-of-rebasing-3.png["Someone pushes rebased commits, abandoning commits you've based your work on."]
167+
image::images/perils-of-rebasing-3.png["Someone pushes rebased commits, abandoning commits you've based your work on"]
168168

169169
Now you're both in a pickle.
170170
If you do a `git pull`, you'll create a merge commit which includes both lines of history, and your repository will look like this:

book/03-git-branching/sections/remote-branches.asc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you run `git clone -o booyah` instead, then you will have `booyah/master` as
2828
====
2929

3030
.Server and local repositories after cloning
31-
image::images/remote-branches-1.png[Server and local repositories after cloning.]
31+
image::images/remote-branches-1.png[Server and local repositories after cloning]
3232

3333
If you do some work on your local `master` branch, and, in the meantime, someone else pushes to `git.ourcompany.com` and updates its `master` branch, then your histories move forward differently.
3434
Also, as long as you stay out of contact with your `origin` server, your `origin/master` pointer doesn't move.
@@ -40,7 +40,7 @@ To synchronize your work with a given remote, you run a `git fetch <remote>` com
4040
This command looks up which server "`origin`" is (in this case, it's `git.ourcompany.com`), fetches any data from it that you don't yet have, and updates your local database, moving your `origin/master` pointer to its new, more up-to-date position.
4141

4242
.`git fetch` updates your remote-tracking branches
43-
image::images/remote-branches-3.png[`git fetch` updates your remote references]
43+
image::images/remote-branches-3.png[`git fetch` updates your remote-tracking branches]
4444

4545
To demonstrate having multiple remote servers and what remote branches for those remote projects look like, let's assume you have another internal Git server that is used only for development by one of your sprint teams.
4646
This server is at `git.team1.ourcompany.com`.
@@ -54,7 +54,7 @@ Now, you can run `git fetch teamone` to fetch everything the remote `teamone` se
5454
Because that server has a subset of the data your `origin` server has right now, Git fetches no data but sets a remote-tracking branch called `teamone/master` to point to the commit that `teamone` has as its `master` branch.
5555

5656
.Remote-tracking branch for `teamone/master`
57-
image::images/remote-branches-5.png[Remote tracking branch for `teamone/master`]
57+
image::images/remote-branches-5.png[Remote-tracking branch for `teamone/master`]
5858

5959
[[_pushing_branches]]
6060
==== Pushing

book/05-distributed-git/sections/maintaining.asc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ image::images/merging-workflows-4.png[After a topic branch merge]
334334

335335
[[merwf_e]]
336336
.After a project release
337-
image::images/merging-workflows-5.png[After a topic branch release]
337+
image::images/merging-workflows-5.png[After a project release]
338338

339339
This way, when people clone your project's repository, they can either check out `master` to build the latest stable version and keep up to date on that easily, or they can check out `develop`, which is the more cutting-edge content.
340340
You can also extend this concept by having an `integrate` branch where all the work is merged together.

book/06-github/sections/1-setting-up-account.asc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ image::images/account-settings.png[The “Account settings” link]
3737

3838
Then select the "`SSH keys`" section along the left-hand side.
3939

40-
.The "`SSH keys`" link.
40+
.The "`SSH keys`" link
4141
image::images/ssh-keys.png[The “SSH keys” link]
4242

4343
From there, click the "`Add an SSH key`" button, give your key a name, paste the contents of your `~/.ssh/id_rsa.pub` (or whatever you named it) public-key file into the text area, and click "`Add key`".
@@ -59,7 +59,7 @@ image::images/your-profile.png[The “Profile” link]
5959

6060
We'll choose a copy of the Git logo that is on our hard drive and then we get a chance to crop it.
6161

62-
.Crop your avatar
62+
.Crop your uploaded avatar
6363
image::images/avatar-crop.png[Crop your uploaded avatar]
6464

6565
Now anywhere you interact on the site, people will see your avatar next to your username.
@@ -72,7 +72,7 @@ The way that GitHub maps your Git commits to your user is by email address.
7272
If you use multiple email addresses in your commits and you want GitHub to link them up properly, you need to add all the email addresses you have used to the Emails section of the admin section.
7373

7474
[[_add_email_addresses]]
75-
.Add email addresses
75+
.Add all your email addresses
7676
image::images/email-settings.png[Add all your email addresses]
7777

7878
In <<_add_email_addresses>> we can see some of the different states that are possible.

book/06-github/sections/2-contributing.asc

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ It is almost always worthwhile to put some effort into this, since a good descri
135135
We also see a list of the commits in our topic branch that are "`ahead`" of the `master` branch (in this case, just the one) and a unified diff of all the changes that will be made should this branch get merged by the project owner.
136136

137137
.Pull Request creation page
138-
image::images/blink-03-pull-request-open.png[Pull Request creation]
138+
image::images/blink-03-pull-request-open.png[Pull Request creation page]
139139

140140
When you hit the 'Create pull request' button on this screen, the owner of the project you forked will get a notification that someone is suggesting a change and will link to a page that has all of this information on it.
141141

@@ -154,22 +154,22 @@ Where this conversation may take place over email in the workflows presented in
154154
The project owner can review the unified diff and leave a comment by clicking on any of the lines.
155155

156156
.Comment on a specific line of code in a Pull Request
157-
image::images/blink-04-pr-comment.png[PR line comment]
157+
image::images/blink-04-pr-comment.png[Comment on a specific line of code in a Pull Request]
158158

159159
Once the maintainer makes this comment, the person who opened the Pull Request (and indeed, anyone else watching the repository) will get a notification.
160160
We'll go over customizing this later, but if he had email notifications turned on, Tony would get an email like this:
161161

162162
[[_email_notification]]
163163
.Comments sent as email notifications
164-
image::images/blink-04-email.png[Email notification]
164+
image::images/blink-04-email.png[Comments sent as email notifications]
165165

166166
Anyone can also leave general comments on the Pull Request.
167167
In <<_pr_discussion>> we can see an example of the project owner both commenting on a line of code and then leaving a general comment in the discussion section.
168168
You can see that the code comments are brought into the conversation as well.
169169

170170
[[_pr_discussion]]
171171
.Pull Request discussion page
172-
image::images/blink-05-general-comment.png[PR discussion page]
172+
image::images/blink-05-general-comment.png[Pull Request discussion page]
173173

174174
Now the contributor can see what they need to do in order to get their change accepted.
175175
Luckily this is very straightforward.
@@ -180,7 +180,7 @@ Adding commits to an existing Pull Request doesn't trigger a notification, so on
180180

181181
[[_pr_final]]
182182
.Pull Request final
183-
image::images/blink-06-final.png[PR final]
183+
image::images/blink-06-final.png[Pull Request final]
184184

185185
An interesting thing to notice is that if you click on the "`Files Changed`" tab on this Pull Request, you'll get the "`unified`" diff -- that is, the total aggregate difference that would be introduced to your main branch if this topic branch was merged in.
186186
In `git diff` terms, it basically automatically shows you `git diff master...<branch>` for the branch this Pull Request is based on.
@@ -229,7 +229,7 @@ GitHub will test this for you and let you know at the bottom of every Pull Reque
229229

230230
[[_pr_fail]]
231231
.Pull Request does not merge cleanly
232-
image::images/pr-01-fail.png[PR merge failure]
232+
image::images/pr-01-fail.png[Pull Request does not merge cleanly]
233233

234234
If you see something like <<_pr_fail>>, you'll want to fix your branch so that it turns green and the maintainer doesn't have to do extra work.
235235

@@ -287,7 +287,7 @@ Once you do that, the Pull Request will be automatically updated and re-checked
287287

288288
[[_pr_merge_fix]]
289289
.Pull Request now merges cleanly
290-
image::images/pr-02-merge-fix.png[PR fixed]
290+
image::images/pr-02-merge-fix.png[Pull Request now merges cleanly]
291291

292292
One of the great things about Git is that you can do that continuously.
293293
If you have a very long-running project, you can easily merge from the target branch over and over again and only have to deal with conflicts that have arisen since the last time that you merged, making the process very manageable.
@@ -314,13 +314,13 @@ We can fill out the description just like <<_pr_references>>.
314314

315315
[[_pr_references]]
316316
.Cross references in a Pull Request
317-
image::images/mentions-01-syntax.png[PR references]
317+
image::images/mentions-01-syntax.png[Cross references in a Pull Request]
318318

319319
When we submit this pull request, we'll see all of that rendered like <<_pr_references_render>>.
320320

321321
[[_pr_references_render]]
322322
.Cross references rendered in a Pull Request
323-
image::images/mentions-02-render.png[PR references rendered]
323+
image::images/mentions-02-render.png[Cross references rendered in a Pull Request]
324324

325325
Notice that the full GitHub URL we put in there was shortened to just the information needed.
326326

@@ -330,7 +330,7 @@ The link will look something like <<_pr_closed>>.
330330

331331
[[_pr_closed]]
332332
.Link back to the new Pull Request in the closed Pull Request timeline
333-
image::images/mentions-03-closed.png[PR closed]
333+
image::images/mentions-03-closed.png[Link back to the new Pull Request in the closed Pull Request timeline]
334334

335335
In addition to issue numbers, you can also reference a specific commit by SHA-1.
336336
You have to specify a full 40 character SHA-1, but if GitHub sees that in a comment, it will link directly to the commit.
@@ -346,7 +346,7 @@ See <<_example_markdown>> for an example of how comments or text can be written
346346

347347
[[_example_markdown]]
348348
.An example of GitHub Flavored Markdown as written and as rendered
349-
image::images/markdown-01-example.png[Example Markdown]
349+
image::images/markdown-01-example.png[An example of GitHub Flavored Markdown as written and as rendered]
350350

351351
The GitHub flavor of Markdown adds more things you can do beyond the basic Markdown syntax.
352352
These can all be really useful when creating useful Pull Request or Issue comments or descriptions.
@@ -370,7 +370,7 @@ If we include this in the description of our Pull Request or Issue, we'll see it
370370

371371
[[_eg_task_lists]]
372372
.Task lists rendered in a Markdown comment
373-
image::images/markdown-02-tasks.png[Example Task List]
373+
image::images/markdown-02-tasks.png[Task lists rendered in a Markdown comment]
374374

375375
This is often used in Pull Requests to indicate what all you would like to get done on the branch before the Pull Request will be ready to merge.
376376
The really cool part is that you can simply click the checkboxes to update the comment -- you don't have to edit the Markdown directly to check tasks off.
@@ -382,7 +382,7 @@ You can see an example of this in <<_task_list_progress>>.
382382

383383
[[_task_list_progress]]
384384
.Task list summary in the Pull Request list
385-
image::images/markdown-03-task-summary.png[Example Task List]
385+
image::images/markdown-03-task-summary.png[Task list summary in the Pull Request list]
386386

387387
These are incredibly useful when you open a Pull Request early and use it to track your progress through the implementation of the feature.
388388

@@ -409,7 +409,7 @@ In the case of the above example, it would end up rendering like <<_md_code>>.
409409

410410
[[_md_code]]
411411
.Rendered fenced code example
412-
image::images/markdown-04-fenced-code.png[Rendered fenced code]
412+
image::images/markdown-04-fenced-code.png[Rendered fenced code example]
413413

414414
===== Quoting
415415

@@ -431,7 +431,7 @@ Once rendered, the comment will look like <<_md_quote>>.
431431

432432
[[_md_quote]]
433433
.Rendered quoting example
434-
image::images/markdown-05-quote.png[Rendered quoting]
434+
image::images/markdown-05-quote.png[Rendered quoting example]
435435

436436
===== Emoji
437437

@@ -442,7 +442,7 @@ If you are typing a comment and you start with a `:` character, an autocompleter
442442

443443
[[_md_emoji_auto]]
444444
.Emoji autocompleter in action
445-
image::images/markdown-06-emoji-complete.png[Emoji autocompleter]
445+
image::images/markdown-06-emoji-complete.png[Emoji autocompleter in action]
446446

447447
Emojis take the form of `:<name>:` anywhere in the comment.
448448
For instance, you could write something like this:
@@ -462,7 +462,7 @@ When rendered, it would look something like <<_md_emoji>>.
462462

463463
[[_md_emoji]]
464464
.Heavy emoji commenting
465-
image::images/markdown-07-emoji.png[Emoji]
465+
image::images/markdown-07-emoji.png[Heavy emoji commenting]
466466

467467
Not that this is incredibly useful, but it does add an element of fun and emotion to a medium that is otherwise hard to convey emotion in.
468468

@@ -482,7 +482,7 @@ In addition to adding Markdown image links to comments, which can be difficult t
482482

483483
[[_md_drag]]
484484
.Drag and drop images to upload them and auto-embed them
485-
image::images/markdown-08-drag-drop.png[Drag and drop images]
485+
image::images/markdown-08-drag-drop.png[Drag and drop images to upload them and auto-embed them]
486486

487487
If you look at <<_md_drag>>, you can see a small "`Parsed as Markdown`" hint above the text area.
488488
Clicking on that will give you a full cheat sheet of everything you can do with Markdown on GitHub.

0 commit comments

Comments
 (0)