Skip to content

Commit 9a9b165

Browse files
committed
DOCTOOLS.README.md: Cleaned up headings
Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
1 parent c81be6d commit 9a9b165

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

DOCTOOLS.README.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Documentation Tools Cheatsheet for Beginners
1+
# Documentation tools cheatsheet for beginners
22

33
CFEngine technical documentation is written using a Markdown formatting (see [Markdown Cheatsheet][Markdown Cheatsheet]) and published using a combination of Jekyll and various plugins (see [CFEngine Documentation][CFEngine Documentation]).
44

55
The various Markdown and other files (e.g. images) that make up the volume of CFEngine documentation are held in a master source code repository. Contributors to the documentation make their own changes in local copies of the documentation Markdown on their own machines and then push those changes to a remote branch.
66

77
From there a request is made to merge the modifications back into the mainline, from which the Jekyll tooling will be triggered to import and then render the final documentation in HTML.
88

9-
## Git and GitHub ##
9+
## Git and GitHub
1010

1111
Git is the repository system in use for CFEngine technical documentation, and the remote repositories are hosted on GitHub.
1212

@@ -20,7 +20,7 @@ setup then manage repositories and users that they would otherwise need to do
2020
themselves. In general it contains many features and improvements to a normal
2121
Git workflow.
2222

23-
### Downloading and Installing Git on Windows ###
23+
### Downloading and installing Git on Windows
2424

2525
1. Go to the Git website at http://git-scm.com/
2626
2. Go to the download section. At the time of writing this was http://git-scm.com/downloads.
@@ -30,19 +30,19 @@ Git workflow.
3030
6. If you see a security warning select `Run`, and for `User Account Control` select `Yes`.
3131
7. Follow the instructions in the installer. It is safe to accept all the default values.
3232

33-
### Launching Git Bash ###
33+
### Launching Git Bash
3434

3535
1. Using Windows Explorer, open a directory where you wish to store CFEngine related Git repositories (e.g. D:\Projects\CFEngine).
3636
2. Right click to bring up the contextual menu.
3737
3. Select `Git Bash`
3838
![Contextual Menu With Git Bash](Doctools-ReadMe-Git-Bash.png)
3939
4. A `Command Prompt` style window will open. This is where you will enter Git commands.
4040

41-
### Using Git ###
41+
### Using Git
4242

4343
Git is a very powerful and robust command line tool at its heart. While it has a great number of commands, some of which are similar to one another, for the beginner there are generally only a few simple ones they need to learn to get started -- and a few more complicated ones to get themselves out of trouble!
4444

45-
#### Good Git Commands to Learn ####
45+
#### Good Git commands to learn
4646

4747
* clone
4848
* add
@@ -51,33 +51,32 @@ Git is a very powerful and robust command line tool at its heart. While it has a
5151
* pull
5252
* reset
5353

54-
#### Basic Examples ####
54+
#### Basic examples
5555

5656
Note: Statements using the following format `> git command something` are to be done on the command line (e.g. Command Prompt/PowerShell on Windows, bash etc. on Linux / Mac). Do not type the `>` at the start of the statement -- beging typing the instructions that follow it (e.g. `git...`).
5757

58-
##### Cloning a Remote Repository #####
58+
##### Cloning a remote repository
5959

6060
1. `> git clone https://github.com/cfengine/documentation.git`
6161

6262
This will clone the repository from the URL indicated into a sub-directory called `documentation`.
6363

64-
##### Cloning a Remote Repository, Making and Committing Changes #####
64+
##### Cloning a remote repository, making and committing changes
6565

6666
1. `> git clone https://github.com/cfengine/documentation.git`
6767
2. Edit any of the files in the `documentation` sub-directory.
6868
3. `> git commit -a -m "This is a note about the changes that were made"`
6969

70-
##### Cloning a Remote Repository and Configuring a `Remote` #####
70+
##### Cloning a remote repository and configuring a remote
7171

7272
1. `> git clone https://github.com/cfengine/documentation.git`
7373
2. `> cd documentation`
7474
3. `> git remote add upstream https://github.com/cfengine/documentation.git`
7575

7676
Note: If working with a clone that you do not have rights to push to then you will need to add a remote for it and push changes to there first.
7777

78-
### Git (and Related) Resources ###
78+
### Git (and related) resources
7979

8080
* The Wikipedia article on Git provides a good overview of the software: http://en.wikipedia.org/wiki/Git_(software).
8181
* The official Git documentation has excellent content for learning how to use Git: http://git-scm.com/documentation.
8282
* GitHub's Help section has many useful tips and tricks, as well as guidance on how to setup Git, create Git repos, fork of repos and contribute to Git supported software projects: https://help.github.com/
83-

0 commit comments

Comments
 (0)