Explorar el Código

clarify content for contributing

mitm001 hace 5 años
padre
commit
c7d4c789fd

+ 10 - 42
README.adoc

@@ -38,49 +38,17 @@ An easy to use primer for GitHub commands can be found here:
 There are a few simple rules to follow when contributing.
 
 . It's not required but it's a good idea to give a heads up you made a P/R on the link:https://hub.jmonkeyengine.org/[jMonkeyEngine Forum] under the `Documentation` topic.
-.  When adding documents, make sure to always complete the header of your document first.
-** see link:https://wiki.jmonkeyengine.org/docs/wiki/wiki_header.html[Anatomy of a Wiki Header]
-.  The docs are modular so you can create your own Antora site playbook and module and it can be included in the wiki and maintained by you. see link:https://docs.antora.org/antora/2.3/[Antora Docs].
-. You can create modules and submit them here also.
-.  When linking to other Wiki pages located in the `ROOT` module, always use an "`Inter-Document Cross Reference`" with the format,
-** ++<<path/to/wiki/page#,custom label text>>++
-+
---
-The `#` sign substitutes for the file extension. This type of link will first look for the `.adoc` file and if not found default to the `.html` version.
-
-The path should be relative to the `pages` folder.
-
-For example: `++<<jme3/requirements#,Software and hardware requirements>>++` +
-links to the `requirements.adoc` page, which lives in a sub-folder of `pages` named `jme3`.
-
-See link:http://asciidoctor.org/docs/user-manual/#inter-document-cross-references[http://asciidoctor.org/docs/user-manual/#inter-document-cross-references] for more info.
---
-. See link:https://docs.antora.org/antora/2.3/navigation/[Antora Navigation] for creating nav menues and navigation between modules.
-.  When linking to images stored in the wiki repository, always use an image prefix in front of the file name and square brackets after it with the format,
-**  Image on its own line  - `image::path/to/image.jpg[image alt text,width=" ",height=" ", align=" "]`
-+
---
-For example: `++image::jme3/beginner/beginner-assets-models.png[beginner-assets-models.png,320,250,align="center"]++`
-
-*  This image is on its own line.
-*  Is stored in the `jme3/beginner` folder which lives in the `images` folder.
-*  Is named `beginner-assets-models.png`.
-*  Has a `alt text` name of `beginner-assets-models.png`.
-*  Has a width of 320.
-*  Has a height of 250.
-*  Is aligned in the center of the page.
---
-**  If you want to include an image inline, use the `image:` prefix instead (notice there is only one colon):
-+
-See link:http://asciidoctor.org/docs/user-manual/#images[http://asciidoctor.org/docs/user-manual/#images] for in depth instructions.
-. When linking to the jMonkeyEngine javadocs, use the global attribute `pass:[{link-javadoc}]` in your link path.
-+
-.Link example
-```
-link:{link-javadoc}/com/jme3/app/state/BaseAppState.html[BaseAppState]
-```
-** see link:https://wiki.jmonkeyengine.org/docs/wiki/wiki_header.html[Anatomy of a Wiki Header] for details on how to override this setting.
+. When adding documents, make sure to always complete the header of your document first.
+. The docs are modular so you can create your own Antora site playbook and module and it can be included in the wiki and maintained by you. +
+  see link:https://docs.antora.org/antora/2.3/[Antora Docs]. +
+  You can create modules and submit them here also.
+
+The wiki is an Anotora documentation site. It is recommended that you read at least these paragraphs to inform yourself on how to build pages and submit them for review to the wiki.
 
+* link:https://wiki.jmonkeyengine.org/docs/wiki/atom_editor.html#source-structure[Source Structure]
+* link:https://wiki.jmonkeyengine.org/docs/wiki/atom_editor.html#updating-local-wiki-copies[Updating Local Wiki Copies]
+* link:https://wiki.jmonkeyengine.org/docs/wiki/atom_editor.html#pushing-changes[Pushing Changes]
+* link:https://wiki.jmonkeyengine.org/docs/wiki/atom_editor.html#creating-pages[Creating Pages]
 == Build & Preview
 
 To set up the Antora environment, you'll need Nodejs (tested with node 12).

+ 25 - 22
docs/modules/wiki/pages/atom_editor.adoc

@@ -4,7 +4,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
 
@@ -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.
 
-*  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]
 ..  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.
 
 .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
-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.
 
-.  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
 
 .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
-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.
-.  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
@@ -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.
 
-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
 

+ 1 - 0
docs/modules/wiki/partials/non-member-important.adoc

@@ -0,0 +1 @@
+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 or the (CLI).