Merge pull request #3 from evennia/master

Sync to master

.github/ISSUE_TEMPLATE/bug-report-develop.md

@@ -0,0 +1,27 @@
+---
+name: Bug report (branch-develop)
+about: Use this to report errors in the Evennia `develop` branch
+title: "[BUG - Develop] (Enter a brief description here)"
+labels: bug, branch-develop
+assignees: ''
+
+---
+
+#### Describe the bug
+<!--(Summarize your bug as clearly as possible here)-->
+
+#### To Reproduce
+Steps to reproduce the behavior:
+1.
+2.
+3.
+4. See error
+
+#### Expected behavior
+<!--(Add a clear and concise description of what you expected to happen.)-->
+
+#### Develop-branch commit
+<!-- (The develop-branch commit-hash. If unsure, run `evennia -v` or get the first few lines of the `about` command in-game.) -->
+
+#### Additional context
+<!--(Add with any other context about the problem, or ideas on how to solve.)-->

.github/ISSUE_TEMPLATE/bug-report.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 #### Describe the bug
-(Replace with a clear and concise description of what the bug is.)
+<!--(Write with a clear and concise description of what the bug is.)-->
 
 #### To Reproduce
 Steps to reproduce the behavior:
@@ -18,10 +18,10 @@ Steps to reproduce the behavior:
 4. See error
 
 #### Expected behavior
-(Replace with a clear and concise description of what you expected to happen.)
+<!--(Write a clear and concise description of what you expected to happen.)-->
 
 #### Environment, Evennia version, OS etc
-(Replace with info. If unsure, run `evennia -v` or get the first few lines of the `about` command in-game.)
+<!--(Add Evennia version and ideally commit hash. If unsure, run `evennia -v` or get the first few lines of the `about` command in-game.)-->
 
 #### Additional context
-(Replace with any other context about the problem, or ideas on how to solve.)
+<!--(Add with any other context about the problem, or ideas on how to solve.)-->

.github/ISSUE_TEMPLATE/documentation-issue.md

@@ -7,11 +7,11 @@ assignees: ''
 
 ---
 
-#### Existing page / new
-(Link to existing documentation page or proposed name of new page)
+#### Documentation page name and link
+<!--(Give the name and link to the documentation page that needs changes, or the proposed name of a new page)-->
 
-#### Documentation issue
-(Replace with the description of what the issue is or motivate a changes/additions)
+#### Reason for issue
+<!--(Motivate why you suggest this change)-->
 
 #### Suggested change
-(Enter the suggested change here)
+<!--(Enter the suggested change here)-->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -8,13 +8,13 @@ assignees: ''
 ---
 
 #### Is your feature request related to a problem? Please describe.
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!--(Optional - a concise description of what the problem is. Ex. I'm always frustrated when [...])-->
 
 #### Describe the solution you'd like
-A clear and concise description of what you want to happen.
+<!--(A clear and concise description of what you want to happen after this feature is added)-->
 
-#### Describe alternatives you've considered
-A clear and concise description of any alternative solutions or features you've considered.
+#### Alternatives you've considered
+<!--(Describe any alternatives you've already considered/tried, if any)-->
 
 #### Additional context
-Add any other context or screenshots about the feature request here.
+<!--(Any other info, links, images etc that can help with implementing or motivate adding this feature)-->

.github/workflows/github_action_test_suite.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8]
+        python-version: [3.7, 3.8, 3.9]
         TESTING_DB: ['sqlite3', 'postgresql', 'mysql']
 
     steps:
@@ -44,7 +44,7 @@ jobs:
         mysql user: 'evennia'
         mysql password: 'password'
 
-    # wait for db to activage, get logs from their start
+    # wait for db to activate, get logs from their start
     - name: Wait / sleep
       uses: jakejarvis/wait-action@v0.1.0
       if: ${{ matrix.TESTING_DB == 'postgresql' || matrix.TESTING_DB == 'mysql' }}
@@ -107,3 +107,36 @@ jobs:
       with:
         project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
         coverage-reports: ./testing_mygame/coverage.xml
+
+    # docker setup and push
+    -
+      name: Set up QEMU
+      if: matrix.TESTING_DB == 'sqlite3' && matrix.python-version == 3.7
+      uses: docker/setup-qemu-action@v1
+    -
+      name: Set up Docker Buildx
+      if: matrix.TESTING_DB == 'sqlite3' && matrix.python-version == 3.7
+      uses: docker/setup-buildx-action@v1
+    -
+      name: Login to DockerHub
+      if: matrix.TESTING_DB == 'sqlite3' && matrix.python-version == 3.7 && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop')
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+    -
+      name: Build and push for master
+      if: matrix.TESTING_DB == 'sqlite3' && matrix.python-version == 3.7 && github.ref == 'refs/heads/master'
+      id: docker_build_master
+      uses: docker/build-push-action@v2
+      with:
+        push: true
+        tags: evennia/evennia:latest
+    -
+      name: Build and push for develop
+      if: matrix.TESTING_DB == 'sqlite3' && matrix.python-version == 3.7 && github.ref == 'refs/heads/develop'
+      id: docker_build_develop
+      uses: docker/build-push-action@v2
+      with:
+        push: true
+        tags: evennia/evennia:develop

CODING_STYLE.md

@@ -199,7 +199,7 @@ or in the chat.
 
 [pep8]: http://www.python.org/dev/peps/pep-0008
 [pep8tool]: https://pypi.python.org/pypi/pep8
-[googlestyle]: http://www.sphinx-doc.org/en/stable/ext/example_google.html
+[googlestyle]: https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html
 [githubmarkdown]: https://help.github.com/articles/github-flavored-markdown/
 [markdown-hilight]: https://help.github.com/articles/github-flavored-markdown/#syntax-highlighting
 [command-docstrings]: https://github.com/evennia/evennia/wiki/Using%20MUX%20As%20a%20Standard#documentation-policy

README.md

@@ -60,22 +60,22 @@ introduction][introduction] to read.
 
 To learn how to get your hands on the code base, the [Getting
 started][gettingstarted] page is the way to go. Otherwise you could
-browse the [Documentation][wiki] or why not come join the [Evennia
+browse the [Documentation][docs] or why not come join the [Evennia
 Community forum][group] or join us in our [development chat][chat].
 Welcome!
 
 
-[homepage]: http://www.evennia.com
-[gettingstarted]: http://github.com/evennia/evennia/wiki/Getting-Started
-[wiki]: https://github.com/evennia/evennia/wiki
+[homepage]: https://www.evennia.com
+[gettingstarted]: https://www.evennia.com/docs/latest/Getting-Started.html
+[docs]: https://www.evennia.com/docs/latest
 [screenshot]: https://user-images.githubusercontent.com/294267/30773728-ea45afb6-a076-11e7-8820-49be2168a6b8.png
 [logo]: https://github.com/evennia/evennia/blob/master/evennia/web/website/static/website/images/evennia_logo.png
 [unittestciimg]: https://github.com/evennia/evennia/workflows/test-suite/badge.svg
 [unittestcilink]: https://github.com/evennia/evennia/actions?query=workflow%3Atest-suite
 [coverimg]: https://coveralls.io/repos/github/evennia/evennia/badge.svg?branch=master
 [coverlink]: https://coveralls.io/github/evennia/evennia?branch=master
-[introduction]: https://github.com/evennia/evennia/wiki/Evennia-Introduction
-[license]: https://github.com/evennia/evennia/wiki/Licensing
-[group]: https://groups.google.com/forum/#!forum/evennia
-[chat]: http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb
+[introduction]: https://www.evennia.com/docs/latest/Evennia-Introduction.html
+[license]: https://www.evennia.com/docs/latest/Licensing.html
+[group]: https://github.com/evennia/evennia/discussions
+[chat]: https://discord.gg/AJJpcRUhtF
 [wikimudpage]: http://en.wikipedia.org/wiki/MUD

docs/README.md

@@ -10,15 +10,15 @@ The live documentation is (will in the future be) available at `https://evennia.
 # Editing the docs
 
 The documentation source files are `*.md` (Markdown) files found in `evennia/docs/source/`.
-Markdown files are simple text files that can be edited with a normal text editor. They primaroly use
+Markdown files are simple text files that can be edited with a normal text editor. They primarily use
 the [Markdown][commonmark] syntax. See [the syntax section below](#Editing-syntax) for more help.
 
 Don't edit the files in `source/api/`. These are auto-generated and your changes
 will be lost.
 
 ## Contributing
 
-Contributing to the docs is is like [contributing to the rest of Evennia][contributing]:
+Contributing to the docs is like [contributing to the rest of Evennia][contributing]:
 Check out the branch of Evennia you want to edit the documentation for. Create your
 own work-branch, make your changes to files in `evennia/docs/source/` and make a PR for it!
 
@@ -66,7 +66,7 @@ All is done in your terminal/console.
 The full documentation includes both the doc pages and the API documentation
 generated from the Evennia source. For this you must install Evennia and
 initialize a new game with a default database (you don't need to have it
-running)
+running).
 
 - Follow the normal [Evennia Getting-Started instructions][getting-started]
   to install Evennia. Use a virtualenv.
@@ -79,7 +79,7 @@ repo with
     ```
 
 - Then `cd` into it and create a new, empty database. You don't need to start the game
-  or do any further changes.
+  or make any further changes.
 
     ```
     evennia migrate
@@ -104,7 +104,7 @@ repo with
     pip install -r requirements.txt
     ```
 
-- Finally, build the full documentation, including the auto-docs:
+- Finally, build the full documentation including the auto-docs:
 
     ```
     make local
@@ -274,7 +274,7 @@ The Evennia documentation supports some special reference shortcuts in links:
 
     This will generate a link to https://github.com/evennia/evennia/issues/new/choose.
 
- > For some reason these particular shortcuts gives a warning during documentation compilation. This 
+ > For some reason these particular shortcuts give a warning during documentation compilation. This warning
  > can be ignored. 
 
 ## Verbatim text
@@ -304,7 +304,7 @@ Everything within these backticks will be verbatim.
 
 ## Code blocks
 
-A special case is code examples - we want them to get code-highlighting for readability. This is done by using 
+Code examples are a special case - we want them to get code-highlighting for readability. This is done by using 
 the triple-backticks and specify which language we use:
 
 ````
@@ -318,10 +318,9 @@ def a_python_func(x):
 
 ## ReST blocks
 
-Markdown is easy to read and use. But while it does most of what we need, there are some things it's 
-not quite as expressive as it needs to be. For this we need to fall back to the [ReST][ReST] markup 
-language which the documentation system uses under the hood. This is done by specifying `eval_rst` as 
-the name of the `language` of a literal block: 
+Markdown is easy to read and use, but it isn't as expressive as it needs to be for some things. For this we 
+need to fall back to the [ReST][ReST] markup language which the documentation system uses under the hood. This is 
+done by specifying `eval_rst` as the name of the `language` of a literal block: 
 
 ````
 ```eval_rst

docs/requirements.txt

@@ -1,11 +1,11 @@
 # requirements for building the docs
 
 sphinx==3.2.1
-sphinx-multiversion==0.2.4
-# lunr==0.5.8
+myst-parser==0.15.2
+myst-parser[linkify]==0.15.2
 
-# recommonmark custom branch with evennia-specific fixes
-git+https://github.com/evennia/recommonmark.git@evennia-mods#egg=recommonmark
+# sphinx-multiversion with evennia fixes 
+git+https://github.com/evennia/sphinx-multiversion.git@evennia-mods#egg=sphinx-multiversion
 
 # sphinxcontrib-lunrsearch custom branch with evennia-specific fixes
-git+https://github.com/evennia/sphinxcontrib-lunrsearch.git@evennia-mods#egg=sphinxcontrib-lunrsearch
+# git+https://github.com/evennia/sphinxcontrib-lunrsearch.git@evennia-mods#egg=sphinxcontrib-lunrsearch