|
@@ -4,7 +4,12 @@
|
|
:revdate: 2020/07/12
|
|
:revdate: 2020/07/12
|
|
|
|
|
|
|
|
|
|
-Contributing to the Wiki is now easier than it ever has been. Using the Atom editor will give you an easy to use interface that is cross-platform, has code completion, syntax highlighting, instant AsciiDoctor page previewing, with an integrated GitHub client. The only thing it doesn't do is write the page for you. You can use it in conjunction with the link:https://git-scm.com/[Git] command line interface
|
|
|
|
|
|
+Contributing to the Wiki is now easier than it ever has been. Using the Atom editor will give you an easy to use interface that is cross-platform, has code completion, syntax highlighting, instant AsciiDoctor page previewing, with an integrated GitHub client. The only thing it doesn't do is write the page for you. You can use it in conjunction with the link:https://git-scm.com/[Git] command line interface.
|
|
|
|
+
|
|
|
|
+== Definitions
|
|
|
|
+
|
|
|
|
+* (CLI) - Git Command Line Interface
|
|
|
|
+* (GWI) - GitHub Web Interface
|
|
|
|
|
|
== Prerequisites
|
|
== Prerequisites
|
|
|
|
|
|
@@ -55,7 +60,7 @@ 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.
|
|
. 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]
|
|
|
|
|
|
+* 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]
|
|
* 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:
|
|
.. Open your `.gitconfig` file (located in USER_HOME) and add:
|
|
+
|
|
+
|
|
@@ -84,41 +89,39 @@ You can preview your documents by selecting the document and using the keyboard
|
|
It's a good idea to update your local copy of the Wiki prior to commiting any changes.
|
|
It's a good idea to update your local copy of the Wiki prior to commiting any changes.
|
|
|
|
|
|
.Members
|
|
.Members
|
|
-Update your local copy of the Wiki from the Atom Editor by issuing a Pull command prior to Commit/Push.
|
|
|
|
-
|
|
|
|
-As a member, you issue Git commands from the Atom Editor.
|
|
|
|
|
|
+Update your local copy of the Wiki from the Atom Editor or (CLI) by issuing a Pull command prior to Commit/Push.
|
|
|
|
|
|
.Non-Members
|
|
.Non-Members
|
|
-Update your local copy of the Wiki by issuing a pull request from your forked repository to the Wiki repository prior to pushing your commit to your fork.
|
|
|
|
-
|
|
|
|
-. Go to your version of the repository on GitHub.
|
|
|
|
-. Click the btn:[New Pull Request] button at the top.
|
|
|
|
|
|
+Update your local copy of the Wiki by:
|
|
|
|
+. Issuing a pull request from your forked repository using the (GWI).
|
|
|
|
+.. Go to your version of the repository on GitHub.
|
|
|
|
+.. Click the btn:[New Pull Request] button at the top.
|
|
+
|
|
+
|
|
NOTE: 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.
|
|
|
|
-. Update your local copy by doing a Pull request in Atom.
|
|
|
|
|
|
+.. 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.
|
|
|
|
+. Update your local copy by doing a Pull request in the Atom Editor or (CLI).
|
|
|
|
|
|
-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 commands from Atom.
|
|
|
|
|
|
+include::partial$non-member-important.adoc[]
|
|
|
|
|
|
|
|
|
|
== Pushing Changes
|
|
== Pushing Changes
|
|
|
|
|
|
.Members
|
|
.Members
|
|
-As a member, you issue all Git commands from the Atom Editor.
|
|
|
|
|
|
+As a member, issue a push command from the Atom Editor or (CLI).
|
|
|
|
|
|
.Non-Members
|
|
.Non-Members
|
|
-To submit changes to the Wiki repository after pushing them to your fork:
|
|
|
|
|
|
+To submit changes to the Wiki repository, after pushing them to your fork, from the (GWI):
|
|
|
|
|
|
. Go to your version of the Wiki repository on GitHub.
|
|
. Go to your version of the Wiki repository on GitHub.
|
|
-. Click the btn:[New Pull Request] button at the top.
|
|
|
|
-. 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.
|
|
|
|
|
|
+.. Click the btn:[New Pull Request] button at the top.
|
|
|
|
+... 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.
|
|
|
|
|
|
-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 commands from Atom.
|
|
|
|
|
|
+include::partial$non-member-important.adoc[]
|
|
|
|
|
|
|
|
|
|
== Creating pages
|
|
== Creating pages
|
|
@@ -137,7 +140,7 @@ Documents rely heavily on using `References` to link to other content in the sam
|
|
|
|
|
|
The snippets page contains various forms these `Cross References` that make linking easier.
|
|
The snippets page contains various forms these `Cross References` that make linking easier.
|
|
|
|
|
|
-See also: <<emoji.adoc#How to use emoji in the wiki,How to use emoji in the wiki>>
|
|
|
|
|
|
+See also: <<emoji.adoc#how-to-use-emoji-in-the-wiki,How to use emoji in the wiki>>
|
|
|
|
|
|
== Atom Snippets
|
|
== Atom Snippets
|
|
|
|
|