java
/
jMonkeyEngine-wiki
mirror of https://github.com/jMonkeyEngine/wiki.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
							<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Wiki Contributions :: jMonkeyEngine Docs</title>
    <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs-wiki/3.8/wiki_contributor.html">
    <link rel="next" href="wiki_admin.html">
    <meta name="generator" content="Antora 3.0.1">
    <link rel="stylesheet" href="../../_/css/site.css">
<meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
<meta property="og:description" content="Wiki Contributions">
<meta property="og:title" content="jMonkeyEngine Docs">
<link rel="stylesheet" href="../../_/css/site-extra.css">
<link rel="stylesheet" href="../../_/css/vendor/docsearch.min.css">
<!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css -->
<link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
  </head>
  <body class="article">
<header class="header">
  <nav class="navbar">
    <div class="navbar-brand">
      <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
        <img alt="" src="../../_/img/jme-logo.png" height="32" type="image/x-icon">
      </a>
      <div class="navbar-item hide-for-print">
        <input id="search-input" type="text" placeholder="Search docs">
      </div>
      <button class="navbar-burger" data-target="topbar-nav">
        <span></span>
        <span></span>
        <span></span>
      </button>
    </div>
    <div id="topbar-nav" class="navbar-menu">
      <div class="navbar-end">
        <div class="navbar-item theme-switch-wrapper">
          <label class="theme-switch" for="checkbox">
            <input type="checkbox" id="checkbox" />
            <div class="slider round"></div>
          </label>
        </div>
        <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
      </div>
    </div>
  </nav>
</header>
<div class="body">
<div class="nav-container" data-component="docs-wiki" data-version="3.8">
  <aside class="nav">
    <div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
  <nav class="nav-menu">
    <h3 class="title"><a href="wiki_contributor.html">Wiki Contribution</a></h3>
<ul class="nav-list">
  <li class="nav-item" data-depth="0">
<ul class="nav-list">
  <li class="nav-item is-current-page" data-depth="1">
    <a class="nav-link" href="wiki_contributor.html">Contributor</a>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="wiki_admin.html">Admin</a>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="emoji.html">Emoji</a>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="atom_editor.html">Atom Editor</a>
  </li>
  <li class="nav-item" data-depth="1">
    <a class="nav-link" href="atom_snippets.html">Atom Snippets</a>
  </li>
</ul>
  </li>
</ul>
  </nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
  <div class="context">
    <span class="title">Wiki Contribution</span>
    <span class="version">3.8</span>
  </div>
  <ul class="components">
    <li class="component">
      <span class="title">JME</span>
      <ul class="versions">
        <li class="version">
          <a href="../../docs/3.8/documentation.html">3.8</a>
        </li>
        <li class="version">
          <a href="../../docs/3.4/documentation.html">3.4</a>
        </li>
        <li class="version">
          <a href="../../docs/3.3/documentation.html">3.3</a>
        </li>
        <li class="version">
          <a href="../../docs/3.2/documentation.html">3.2</a>
        </li>
      </ul>
    </li>
    <li class="component is-current">
      <span class="title">Wiki Contribution</span>
      <ul class="versions">
        <li class="version is-current">
          <a href="wiki_contributor.html">3.8</a>
        </li>
      </ul>
    </li>
    <li class="component">
      <span class="title">Wiki UI</span>
      <ul class="versions">
        <li class="version">
          <a href="../../wiki-ui/index.html">master</a>
        </li>
      </ul>
    </li>
  </ul>
</div>
    </div>
  </aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<nav class="breadcrumbs" aria-label="breadcrumbs">
  <ul>
    <li><a href="wiki_contributor.html">Wiki Contribution</a></li>
    <li><a href="wiki_contributor.html">Contributor</a></li>
  </ul>
</nav>
  <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs-wiki/modules/ROOT/pages/wiki_contributor.adoc">Edit this Page</a></div>
  </div>
  <div class="content">
<article class="doc">
<h1 class="page">Wiki Contributions</h1>
<div id="preamble">
<div class="sectionbody">
<div class="olist arabic">
<div class="title">Prerequisites</div>
<ol class="arabic">
<li>
<p>Have a <a href="https://github.com/">GitHub account</a>.</p>
</li>
<li>
<p>Optional: Are a Wiki project member.</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>If you are not a member, you can fork the repository into your GitHub account and issue pull requests via github.</p>
</div>
<div class="paragraph">
<p>To fork the Wiki repository into your GitHub Account:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>In the menu at the top of the docs.jmonkeyengine.org page, select the <strong>Fork</strong> button.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The syntax is asciidoctor:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/">Asciidoc Syntax Quick Reference</a></p>
</li>
<li>
<p><a href="https://docs.asciidoctor.org/home/">Asciidoctor User Manual</a></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>An easy to use primer for GitHub commands can be found here:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="http://rogerdudler.github.io/git-guide/">git - the simple guide</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="contribute"><a class="anchor" href="#contribute"></a>Contribute</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The wiki is an Antora documentation site. There are a few simple rules to follow when contributing.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>It&#8217;s not required but it&#8217;s a good idea to give a heads up you made a P/R on the <a href="https://hub.jmonkeyengine.org/">jMonkeyEngine Forum</a> under the <code>Documentation</code> topic.</p>
</li>
<li>
<p>When adding documents, make sure to always complete the <a href="https://docs.antora.org/antora/2.2/asciidoc/page-header/">header</a> of your document first.</p>
</li>
<li>
<p>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.<br>
See: <a href="https://docs.antora.org/antora/2.3/">Antora Docs</a>.<br>
You can create modules and submit them here also.</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>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.</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="atom_editor.html#updating-local-wiki-copies" class="xref page">Updating Local Wiki Copies</a></p>
</li>
<li>
<p><a href="atom_editor.html#pushing-changes" class="xref page">Pushing Changes</a></p>
</li>
<li>
<p><a href="atom_editor.html#creating-pages" class="xref page">Creating Pages</a></p>
</li>
</ul>
</div>
</div>
</div>
<nav class="pagination">
  <span class="next"><a href="wiki_admin.html">Admin</a></span>
</nav>
</article>
<aside class="toc sidebar" data-title="Contents" data-levels="2">
  <div class="toc-menu"></div>
</aside>
  </div>
</main>
</div>
<footer class="footer">
  <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
</footer>
<script src="../../_/js/vendor/docsearch.min.js"></script>
<!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
<script>
var search = docsearch({
  apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  indexName: 'jmonkeyengine',
  inputSelector: '#search-input',
  autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  algoliaOptions: { hitsPerPage: 10 }
}).autocomplete
search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
function focusSearchInput () { document.querySelector('#search-input').focus() }
if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
</script>
<script src="../../_/js/site.js"></script>
<script async src="../../_/js/vendor/highlight.js"></script>
  </body>
</html>