Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-02 22:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-07-14 00:21:00 +02:00
parent a551188691
commit 781788f2e5
2063 changed files with 215958 additions and 250783 deletions
Download patch file Download diff file Expand all files Collapse all files

86
docs/1.0-dev/How-To-Get-And-Give-Help.html
View file

@ -1,19 +1,18 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>How To Get And Give Help &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@ -27,10 +26,8 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">How To Get And Give Help</a></li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">How To Get And Give Help</a></li>
</ul>
</div>
@ -43,22 +40,19 @@
<h1>How To Get And Give Help<a class="headerlink" href="#how-to-get-and-give-help" title="Permalink to this headline"></a></h1>
<div class="section" id="how-to-get-help">
<h2>How to <em>get</em> Help<a class="headerlink" href="#how-to-get-help" title="Permalink to this headline"></a></h2>
<p>If you cannot find what you are looking for in the [online documentation](<a class="reference internal" href="index.html"><span class="doc">online
documentation</span></a>), here’s what to do:</p>
<p>If you cannot find what you are looking for in the documentation, here’s what to do:</p>
<ul class="simple">
<li><p>If you think the documentation is not clear enough and are short on time, fill in our quick little
<a class="reference external" href="https://docs.google.com/spreadsheet/viewform?hl=en_US&amp;formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZGc6MQ#gid=0">online form</a> and let us know - no login required. Maybe the docs need to be improved or a new
tutorial added! Note that while this form is useful as a suggestion box we cannot answer questions
or reply to you. Use the discussion group or chat (linked below) if you want feedback.</p></li>
<li><p>If you have trouble with a missing feature or a problem you think is a bug, go to the <a class="reference external" href="https://github.com/evennia/evennia/issues">issue
tracker</a> and search to see if has been reported/suggested already. If you can’t find an
existing entry create a new one.</p></li>
<li><p>If you think the documentation is not clear enough, create a <a class="reference external" href="https://github.com/evennia/evennia/issues/new/choose">documentation ticket</a>.</p></li>
<li><p>If you have trouble with a missing feature or a problem you think is a bug, look through the
the list of known <a class="reference external" href="https://github.com/evennia/evennia/issues">issue</a> if you can’t find your issue in the list, make a
new one <a class="reference external" href="https://github.com/evennia/evennia/issues/new/choose">here</a>.</p></li>
<li><p>If you need help, want to start a discussion or get some input on something you are working on,
make a post to the <a class="reference external" href="http://groups.google.com/group/evennia/">discussions group</a> This is technically a ‘mailing list’, but you don’t
need to use e-mail; you can post and read all messages just as easily from your browser via the
online interface.</p></li>
<li><p>If you want more direct discussions with developers and other users, consider dropping into our
IRC chat channel [#evennia][chat] on the <em>Freenode</em> network. Please note however that you have to be
IRC chat channel <a class="reference external" href="http://webchat.freenode.net/?channels=evennia">#evennia</a> on the <em>Freenode</em> network. There is also a Discord channel
bridged into the IRC if you prefer that. Please that you have to be
patient if you don’t get any response immediately; we are all in very different time zones and many
have busy personal lives. So you might have to hang around for a while - you’ll get noticed
eventually!</p></li>
@ -66,47 +60,39 @@ eventually!</p></li>
</div>
<div class="section" id="how-to-give-help">
<h2>How to <em>give</em> Help<a class="headerlink" href="#how-to-give-help" title="Permalink to this headline"></a></h2>
<p>Evennia is a completely non-funded project. It relies on the time donated by its users and
developers in order to progress.</p>
<p>The first and easiest way you as a user can help us out is by taking part in <a class="reference external" href="http://groups.google.com/group/evennia/">community
discussions</a> and by giving feedback on what is good or bad. Report bugs you find and features
you lack to our <a class="reference external" href="https://github.com/evennia/evennia/issues">issue tracker</a>. Just the simple act of letting developers know you are out
there using their program is worth a lot. Generally mentioning and reviewing Evennia elsewhere is
also a nice way to spread the word.</p>
<p>Evennia is open-source and non-commercial. It relies on the time donated by its users and developers in order to progress.</p>
<ul class="simple">
<li><p>Spread the word! If you like Evennia, consider writing a blog post about it.</p></li>
<li><p>Take part in the Evennia community! Join the <a class="reference external" href="http://webchat.freenode.net/?channels=evennia">chat</a> or <a class="reference external" href="http://groups.google.com/group/evennia/">forum</a>.</p></li>
<li><p>Report problems you find or features you’d like to our <a class="reference external" href="https://github.com/evennia/evennia/issues/new/choose">issue tracker</a>.</p></li>
</ul>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Just the simple act of us know you are out there using Evennia helps a lot!</p>
</div>
<p>If you’d like to help develop Evennia more hands-on, here are some ways to get going:</p>
<ul class="simple">
<li><p>Look through our [online documentation wiki](<a class="reference internal" href="index.html"><span class="doc">online documentation wiki</span></a>) and see if you
can help improve or expand the documentation (even small things like fixing typos!). You don’t need
any particular permissions to edit the wiki.</p></li>
<li><p>Send a message to our <a class="reference external" href="http://groups.google.com/group/evennia/">discussion group</a> and/or our [IRC chat][chat] asking about what
<li><p>Look through this <a class="reference external" href="index.html#Evennia-documentation">online documentation</a> and see if you can help improve or expand the
documentation (even small things like fixing typos!). <a class="reference internal" href="Contributing-Docs.html"><span class="doc">See here</span></a> on how you
contribute to the docs.</p></li>
<li><p>Send a message to our <a class="reference external" href="http://groups.google.com/group/evennia/">discussion group</a> and/or our <a class="reference external" href="http://webchat.freenode.net/?channels=evennia">IRC chat</a> asking about what
needs doing, along with what your interests and skills are.</p></li>
<li><p>Take a look at our <a class="reference external" href="https://github.com/evennia/evennia/issues">issue tracker</a> and see if there’s something you feel like taking on.
<a class="reference external" href="https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&amp;q=is%3Aissue%20is%3Aopen%20label%3Abug%20label%3Amaster-">here are bugs</a> that need fixes. At any given time there may also be some
[bounties][issues-bounties] open - these are issues members of the community has put up money to see
fixed (if you want to put up a bounty yourself you can do so via our page on
[bountysource][bountysource]).</p></li>
<a class="reference external" href="https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&amp;q=is%3Aissue%20is%3Aopen%20label%3Abug%20label%3Amaster-branch">here are bugs</a> that need fixes. At any given time there may also be some
<a class="reference external" href="https://github.com/evennia/evennia/labels/bounty">bounties</a> open.</p></li>
<li><p>Check out the <a class="reference internal" href="Contributing.html"><span class="doc">Contributing</span></a> page on how to practically contribute with code using
github.</p></li>
</ul>
<p>… And finally, if you want to help motivate and support development you can also drop some coins
in the developer’s cup. You can [make a donation via PayPal][paypal] or, even better, [become an
Evennia patron on Patreon][patreon]! This is a great way to tip your hat and show that you
appreciate the work done with the server! Finally, if you want to encourage the community to resolve
a particular</p>
<p>branch
[chat]: http://webchat.freenode.net/?channels=evennia
[paypal]: https://www.paypal.com/se/cgi-
bin/webscr?cmd=<em>flow&amp;SESSION=Z-VlOvfGjYq2qvCDOUGpb6C8Due7skT0qOklQEy5EbaD1f0eyEQaYlmCc8O&amp;dispatch=5885d80a13c0db1f8e263663d3faee8d64ad11bbf4d2a5a1a0d303a50933f9b2
[donate-img]: http://images-focus-
opensocial.googleusercontent.com/gadgets/proxy?url=https://www.paypalobjects.com/en%255fUS/SE/i/btn/btn%255fdonateCC%255fLG.gif&amp;container=focus&amp;gadget=a&amp;rewriteMime=image/*
[patreon]: https://www.patreon.com/griatch
[patreon-img]: http://www.evennia.com/</em>/rsrc/1424724909023/home/evennia_patreon_100x100.png
[issues-bounties]: https://github.com/evennia/evennia/labels/bounty
[bountysource]: https://www.bountysource.com/teams/evennia</p>
in the developer’s cup. You can <a class="reference external" href="https://www.paypal.com/se/cgi-bin/webscr?cmd=_flow&amp;SESSION=Z-VlOvfGjYq2qvCDOUGpb6C8Due7skT0qOklQEy5EbaD1f0eyEQaYlmCc8O&amp;dispatch=5885d80a13c0db1f8e263663d3faee8d64ad11bbf4d2a5a1a0d303a50933f9b2">make a donation via PayPal</a> or, even better, <a class="reference external" href="https://www.patreon.com/griatch">become an
Evennia patron on Patreon</a>! This is a great way to tip your hat and show that you
appreciate the work done with the server! You can also encourage the community to take on particular
issues by putting up a monetary <a class="reference external" href="https://www.bountysource.com/teams/evennia">bounty</a> on it.</p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
@ -160,15 +146,13 @@ opensocial.googleusercontent.com/gadgets/proxy?url=https://www.paypalobjects.com
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">How To Get And Give Help</a></li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">How To Get And Give Help</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.1.
</div>
</body>
</html>