|
|
@@ -28,8 +28,8 @@ To fork the Wiki repository into your GitHub Account:
|
|
|
. Download and install the Atom editor - https://atom.io/
|
|
|
. After installation is complete, you can customize the editor by selecting the `Choose A Theme` panel followed by the btn:[Theme Picker] button.
|
|
|
. Once you are satisfied with the customization of the editor, you will need to add several packages to make Atom AsciiDoctor compatible. Package installation is painless.
|
|
|
-** From the `Install A Package` panel, select the btn:[Open Installer] button, or select `menu:Packages[Settings View>Install Packages/Themes]` from the file header.
|
|
|
-** Enter "`asciidoc`" in the search box and press the btn:[Packages] button.
|
|
|
+.. From the `Install A Package` panel, select the btn:[Open Installer] button, or select `menu:Packages[Settings View>Install Packages/Themes]` from the file header.
|
|
|
+.. Enter "`asciidoc`" in the search box and press the btn:[Packages] button.
|
|
|
+
|
|
|
.Add these packages:
|
|
|
*** *language-asciidoc* +
|
|
|
@@ -51,10 +51,9 @@ The clone will take some time due to the size of the Wiki. Once cloned, a new `P
|
|
|
|
|
|
. Before you can commit any changes to the Wiki, you must configure at least the user.email and user.name variables for Git. You can do this via Git Bash, or manually, by following these instructions.
|
|
|
|
|
|
-.. Git Bash: link:https://help.github.com/articles/setting-your-commit-email-address-in-git/[Setting your commit email address in Git]
|
|
|
-.. Manually:
|
|
|
-... link:https://help.github.com/articles/setting-your-commit-email-address-on-github/[Set your commit email address on GitHub]
|
|
|
-... Open your `.gitconfig` file (located in USER_HOME) and add:
|
|
|
+* Git Bash: link:https://help.github.com/articles/setting-your-commit-email-address-in-git/[Setting your commit email address in Git]
|
|
|
+* Manually: link:https://help.github.com/articles/setting-your-commit-email-address-on-github/[Set your commit email address on GitHub]
|
|
|
+.. Open your `.gitconfig` file (located in USER_HOME) and add:
|
|
|
+
|
|
|
[source]
|
|
|
----
|
|
|
@@ -62,8 +61,7 @@ The clone will take some time due to the size of the Wiki. Once cloned, a new `P
|
|
|
name = yourname
|
|
|
email = youremail
|
|
|
----
|
|
|
-+
|
|
|
-To maintain your privacy, setup your email settings in your GitHub account and use the `users.noreply.github.com` email address.
|
|
|
+.. To maintain your privacy, setup your email settings in your GitHub account and use the `users.noreply.github.com` email address.
|
|
|
|
|
|
. Lastly, you will need to create a GitHub token. Follow the directions in the popup to enter the token.
|
|
|
|
|
|
@@ -89,14 +87,16 @@ Update your local copy of the Wiki by issuing a pull request from your forked re
|
|
|
|
|
|
.. Go to your version of the repository on GitHub.
|
|
|
.. Click the btn:[New Pull Request] button at the top.
|
|
|
-.. Note that the Wiki repository will be on the left and your repository will be on the right.
|
|
|
++
|
|
|
+NOTE: The Wiki repository will be on the left and your repository will be on the right.
|
|
|
+
|
|
|
.. Click the btn:[Base] button on the left and from the drop down list select your forked repository.
|
|
|
.. Click the "`compare across forks`" link.
|
|
|
.. Click the btn:[Head Fork] button and from the drop down list select the Wiki repository.
|
|
|
.. If the repositories are not identical, there will be green button btn:[Create pull request]. Click it to update your repository.
|
|
|
-.. Now update your local copy by doing a Pull request in Atom.
|
|
|
-+
|
|
|
-As a non-member, you issue commands that affect your fork online, and commands that affect your local copy from Atom.
|
|
|
+.. Update your local copy by doing a Pull request in Atom.
|
|
|
+
|
|
|
+IMPORTANT: As a non-member, when there is interaction between the Wiki repository and your fork, you issue commands online. When the interaction is between your forked repository and your local copy, you issue command from Atom.
|
|
|
|
|
|
|
|
|
== Pushing Changes
|
|
|
@@ -112,7 +112,7 @@ To submit changes to the Wiki repository after pushing them to your fork:
|
|
|
.. Note that the jMonkeyEngine repository will be on the left and your repository will be on the right.
|
|
|
.. Click the green button btn:[Create pull request]. Give a succinct and informative title, in the comment field give a short explanation of the changes and click the green button btn:[Create pull request] again.
|
|
|
|
|
|
-As a non-member, you issue commands that affect your fork online, and commands that affect your local copy from Atom.
|
|
|
+IMPORTANT: As a non-member, when there is interaction between the Wiki repository and your fork, you issue commands online. When the interaction is between your forked repository and your local copy, you issue command from Atom.
|
|
|
|
|
|
|
|
|
== Wiki Template
|
mitm