[v5,2/2] documentation: add anchors to MyFirstContribution
diff mbox series

Message ID 20190507213040.151799-3-emilyshaffer@google.com
State New
Headers show
  • documentation: add lab for first contribution
Related show

Commit Message

Emily Shaffer May 7, 2019, 9:30 p.m. UTC
During the course of review for MyFirstContribution.txt, the suggestion
came up to include anchors to make it easier for veteran contributors to
link specific sections of this documents to newbies. To make life easier
for reviewers, add these anchors in their own commit. See review context
here: https://public-inbox.org/git/20190507195938.GD220818@google.com/

AsciiDoc does not support :sectanchors: and the anchors are not
discoverable, but they are referenceable. So a link to
"foo.com/MyFirstContribution.html#prerequisites" will still work if that
file was generated with AsciiDoc. The inclusion of :sectanchors: does
not create warnings or errors while compiling directly with `asciidoc -b
html5 Documentation/MyFirstContribution.txt` or while compiling with
`make doc`.

AsciiDoctor does support :sectanchors: and displays a paragraph link on
mouseover. When the anchor is included above or inline with a section
(as in this change), the link provided points to the custom ID contained
within [[]] instead of to an autogenerated ID. Practically speaking,
this means we have .../MyFirstContribution.html#summary instead of
.../MyFirstContribution.html#_summary. In addition to being prettier,
the custom IDs also enable anchor linking to work with
asciidoc-generated pages. This change compiles with no warnings using
`asciidoctor -b html5 Documentation/MyFirstContribution.txt`.

Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
 Documentation/MyFirstContribution.txt | 35 +++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff mbox series

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 0f9a7fed93..a0380d5dc8 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -1,16 +1,20 @@ 
 My First Contribution to the Git Project
 == Summary
 This is a tutorial demonstrating the end-to-end workflow of creating a change to
 the Git tree, sending it for review, and making changes based on comments.
 === Prerequisites
 This tutorial assumes you're already fairly familiar with using Git to manage
 source code.  The Git workflow steps will largely remain unexplained.
 === Related Reading
 This tutorial aims to summarize the following documents, but the reader may find
@@ -19,8 +23,10 @@  useful additional context:
 - `Documentation/SubmittingPatches`
 - `Documentation/howto/new-command.txt`
 == Getting Started
 === Clone the Git Repository
 Git is mirrored in a number of locations. Clone the repository from one of them;
@@ -31,6 +37,7 @@  the official mirror on GitHub.
 $ git clone https://github.com/git/git git
 === Identify Problem to Solve
@@ -44,6 +51,7 @@  of invocation during users' typical daily workflow.
 (We've seen some other effort in this space with the implementation of popular
 commands such as `sl`.)
 === Set Up Your Workspace
 Let's start by making a development branch to work on our changes. Per
@@ -62,11 +70,13 @@  $ git checkout -b psuh origin/master
 We'll make a number of commits here in order to demonstrate how to send a topic
 with multiple patches up for review simultaneously.
 == Code It Up!
 NOTE: A reference implementation can be found at
 === Adding a New Command
 Lots of the subcommands are written as builtins, which means they are
@@ -195,6 +205,7 @@  For the remainder of the tutorial, the subject line only will be listed for the
 sake of brevity. However, fully-fleshed example commit messages are available
 on the reference implementation linked at the top of this document.
 === Implementation
 It's probably useful to do at least something besides printing out a string.
@@ -359,6 +370,7 @@  about. Neat! Let's commit that as well.
 $ git commit -sm "psuh: display the top of origin/master"
 === Adding Documentation
 Awesome! You've got a fantastic new command that you're ready to share with the
@@ -446,6 +458,7 @@  sees that your command has been implemented as well as documented) by running
 Go ahead and commit your new documentation change.
 === Adding Usage Text
 Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end.
@@ -502,6 +515,7 @@  your command terminated before anything else interesting happens. Great!
 Go ahead and commit this one, too.
 == Testing
 It's important to test your code - even for a little toy command like this one.
@@ -516,11 +530,13 @@  So let's write some tests.
 Related reading: `t/README`
 === Overview of Testing Structure
 The tests in Git live in `t/` and are named with a 4-digit decimal number using
 the schema shown in the Naming Tests section of `t/README`.
 === Writing Your Test
 Since this a toy command, let's go ahead and name the test with t9999. However,
@@ -569,6 +585,7 @@  You can get an idea of whether you created your new test script successfully
 by running `make -C t test-lint`, which will check for things like test number
 uniqueness, executable bit, and so on.
 === Running Locally
 Let's try and run locally:
@@ -592,6 +609,7 @@  dependencies. `prove` also makes the output nicer.
 Go ahead and commit this change, as well.
 == Getting Ready to Share
 You may have noticed already that the Git project performs its code reviews via
@@ -614,6 +632,7 @@  Regardless of which method you choose, your engagement with reviewers will be
 the same; the review process will be covered after the sections on GitGitGadget
 and `git send-email`.
 == Sending Patches via GitGitGadget
 One option for sending patches is to follow a typical pull request workflow and
@@ -624,6 +643,7 @@  mirror of the Git project, and does some magic to turn the PR into a set of
 emails and send them out for you. It also runs the Git continuous integration
 suite for you. It's documented at http://gitgitgadget.github.io.
 === Forking `git/git` on GitHub
 Before you can send your patch off to be reviewed using GitGitGadget, you will
@@ -633,6 +653,7 @@  you have a GitHub account.
 Head to the https://github.com/git/git[GitHub mirror] and look for the Fork
 button. Place your fork wherever you deem appropriate and create it.
 === Uploading to Your Own Fork
 To upload your branch to your own fork, you'll need to add the new fork as a
@@ -678,6 +699,7 @@  $ git push remotename psuh
 Now you should be able to go and check out your newly created branch on GitHub.
 === Sending a PR to GitGitGadget
 In order to have your code tested and formatted for review, you need to start by
@@ -689,6 +711,7 @@  appear with the name of your newly pushed branch.
 Review the PR's title and description, as it's used by GitGitGadget as the cover
 letter for your change. When you're happy, submit your pull request.
 === Running CI and Getting Ready to Send
 If it's your first time using GitGitGadget (which is likely, as you're using
@@ -713,15 +736,18 @@  your patch is accepted into `next`.
 TODO https://github.com/gitgitgadget/gitgitgadget/issues/83
 It'd be nice to be able to verify that the patch looks good before sending it
 to everyone on Git mailing list.
 === Check Your Work
 === Sending Your Patches
 Now that your CI is passing and someone has granted you permission to use
 GitGitGadget with the `/allow` command, sending out for review is as simple as
 commenting on your PR with `/submit`.
 === Updating With Comments
 Skip ahead to <<reviewing,Responding to Reviews>> for information on how to
@@ -743,6 +769,7 @@  of what they're looking at. When the CI is done running, you can comment once
 more with `/submit` - GitGitGadget will automatically add a v2 mark to your
 == Sending Patches with `git send-email`
 If you don't want to use GitGitGadget, you can also use Git itself to mail your
@@ -751,6 +778,7 @@  subject line (for example, being able to use the tag [RFC PATCH] in the subject)
 and being able to send a ``dry run'' mail to yourself to ensure it all looks
 good before going out to the list.
 === Prerequisite: Setting Up `git send-email`
 Configuration for `send-email` can vary based on your operating system and email
@@ -762,6 +790,7 @@  determine the right way to configure it to use your SMTP server; again, as this
 configuration can change significantly based on your system and email setup, it
 is out of scope for the context of this tutorial.
 === Preparing Initial Patchset
 Sending emails with Git is a two-part process; before you can prepare the emails
@@ -800,6 +829,7 @@  but want reviewers to look at what they have so far. You can add this flag with
 Check and make sure that your patches and cover letter template exist in the
 directory you specified - you're nearly ready to send out your review!
 === Preparing Email
 In addition to an email per patch, the Git community also expects your patches
@@ -863,6 +893,7 @@  The one generated for `psuh` from the sample implementation looks like this:
 Finally, the letter will include the version of Git used to generate the
 patches. You can leave that string alone.
 === Sending Email
 At this point you should have a directory `psuh/` which is filled with your
@@ -887,6 +918,7 @@  press `y` or `a` at these prompts your emails will be sent! Congratulations!
 Awesome, now the community will drop everything and review your changes. (Just
 kidding - be patient!)
 === Sending v2
 Skip ahead to <<reviewing,Responding to Reviews>> for information on how to
@@ -945,6 +977,7 @@  $ git send-email --to=target@example.com
 === Bonus Chapter: One-Patch Changes
 In some cases, your very small change may consist of only one patch. When that
@@ -992,6 +1025,7 @@  index 88f126184c..38da593a60 100644
 == My Patch Got Emailed - Now What?
@@ -1035,6 +1069,7 @@  changing history, but since it's local history which you haven't shared with
 anyone, that is okay for now! (Later, it may not make sense to do this; take a
 look at the section below this one for some context.)
 === After Review Approval
 The Git project has four integration branches: `pu`, `next`, `master`, and