You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]).
4
4
5
5
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.
6
6
7
7
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.
8
8
9
-
## Git and GitHub ##
9
+
## Git and GitHub
10
10
11
11
Git is the repository system in use for CFEngine technical documentation, and the remote repositories are hosted on GitHub.
12
12
@@ -20,7 +20,7 @@ setup then manage repositories and users that they would otherwise need to do
20
20
themselves. In general it contains many features and improvements to a normal
21
21
Git workflow.
22
22
23
-
### Downloading and Installing Git on Windows ###
23
+
### Downloading and installing Git on Windows
24
24
25
25
1. Go to the Git website at http://git-scm.com/
26
26
2. Go to the download section. At the time of writing this was http://git-scm.com/downloads.
@@ -30,19 +30,19 @@ Git workflow.
30
30
6. If you see a security warning select `Run`, and for `User Account Control` select `Yes`.
31
31
7. Follow the instructions in the installer. It is safe to accept all the default values.
32
32
33
-
### Launching Git Bash ###
33
+
### Launching Git Bash
34
34
35
35
1. Using Windows Explorer, open a directory where you wish to store CFEngine related Git repositories (e.g. D:\Projects\CFEngine).
36
36
2. Right click to bring up the contextual menu.
37
37
3. Select `Git Bash`
38
38

39
39
4. A `Command Prompt` style window will open. This is where you will enter Git commands.
40
40
41
-
### Using Git ###
41
+
### Using Git
42
42
43
43
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!
44
44
45
-
#### Good Git Commands to Learn ####
45
+
#### Good Git commands to learn
46
46
47
47
* clone
48
48
* add
@@ -51,33 +51,32 @@ Git is a very powerful and robust command line tool at its heart. While it has a
51
51
* pull
52
52
* reset
53
53
54
-
#### Basic Examples ####
54
+
#### Basic examples
55
55
56
56
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...`).
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.
77
77
78
-
### Git (and Related) Resources ###
78
+
### Git (and related) resources
79
79
80
80
* The Wikipedia article on Git provides a good overview of the software: http://en.wikipedia.org/wiki/Git_(software).
81
81
* The official Git documentation has excellent content for learning how to use Git: http://git-scm.com/documentation.
82
82
* 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/
0 commit comments