2
0
Эх сурвалжийг харах

Added info on how to make changes as nonmember.

mitm 7 жил өмнө
parent
commit
e06810a1fa

+ 70 - 11
src/docs/asciidoc/wiki/atom_editor.adoc

@@ -11,31 +11,49 @@ ifdef::env-github,env-browser[:outfilesuffix: .adoc]
 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.
 
 == Atom Editor Setup
+
+.Prerequisites
+.  Have a link:https://github.com/[GitHub account].
+.  Are a Wiki project member.
+
+If you are not a member, you fork the repository into your GitHub account and issue "`Pull`" requests to the Wiki repository from there.
+
+To fork the Wiki repository into your GitHub Account:
+
+.  Navigate to link:https://github.com/jMonkeyEngine/wiki[https://github.com/jMonkeyEngine/wiki].
+.  In the menu at the top of the page, select the icon:code-fork[]*Fork* button.
+
+== Downloading the Sources
+
 .  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.
-** Add these packages:
 +
-*language-asciidoc* +
-*asciidoc-preview* +
-*autocomplete-asciidoc*  +
-
+.Add these packages:
+*** *language-asciidoc* +
+*** *asciidoc-preview* +
+*** *autocomplete-asciidoc*
 .  To edit the Wiki you will need to clone the wiki repository.
-**  From the `Command Palette` (kbd:[ctrl]+kbd:[shift] +kbd:[P]  or `menu:Packages[Command Palette>Toggle]`), enter "`git`" into the search box.
-**  Select btn:[GitHub: Clone].
-**  Paste `++https://github.com/jMonkeyEngine/wiki++` into the `Clone from` box. The `To directory` will automatically update when you do.
-**  When you're ready, press the btn:[Clone] button.
+..  From the `Command Palette` (kbd:[ctrl]+kbd:[shift] +kbd:[P]  or `menu:Packages[Command Palette>Toggle]`), enter "`git`" into the search box.
+..  Select btn:[GitHub: Clone].
+..  Paste `++https://github.com/jMonkeyEngine/wiki++` into the `Clone from` box. The `To directory` will automatically update when you do.
 +
+IMPORTANT: Use the +++<abbr title="Uniform Resource Locator">URL</abbr>+++ to your repository fork and clone your fork if a non-member.
+
+..  When you're ready, press the btn:[Clone] button.
+
 The clone will take some time due to the size of the Wiki. Once cloned, a new `Project` tab will open on the left, and the `Git` and `GitHub Preview` tabs will open to the right. If they don't, you can open the Git tab using kbd:[ctrl]+kbd:[shift]+kbd:[9]  and the GitHub Preview tab using kbd:[ctrl]+kbd:[shift]+kbd:[8]. Alternatively, you can navigate the `menu:Packages[GitHub]` menu. You will also notice in the lower right corner, on the `Status Bar`, you now have your GitHub control.
 
 All Wiki documents live in the `asciidoc` folder, images in the `images` folder, and resources for your documents in the `resources` folder. Select an appropriate folder under each to store your new document, image or resource.
 
 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.
 
-*  link:https://help.github.com/articles/setting-your-commit-email-address-in-git/[Setting your commit email address in Git]
-*  Manually - Open your `.gitconfig` file 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]
 ----
@@ -55,6 +73,47 @@ You can add more GitHub controls to the editor by adding the package `*git-plus*
 You can preview your documents by selecting the document and using the keyboard shortcut kbd:[ctrl]+kbd:[shift]+kbd:[A] or by using the File header menu menu:Packages[AsciiDoc Preview>Toggle Preview].
 
 
+== Updating Local Wiki Copies
+
+
+It's a good idea to update your local copy of the Wiki prior to commiting any changes.
+
+.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.
+
+.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.
+..  Note that 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.
+
+
+== Pushing Changes
+
+.Members
+As a member, you issue all Git commands from the Atom Editor.
+
+.Non-Members
+To submit changes to the Wiki repository after pushing them to your fork:
+
+..  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.
+
+As a non-member, you issue commands that affect your fork online, and commands that affect your local copy from Atom.
+
+
 == Wiki Template