From 102f0437a4cd572c7f110ba937f991da6990afbc Mon Sep 17 00:00:00 2001 From: lethosor Date: Tue, 15 Jun 2021 00:03:24 -0400 Subject: [PATCH 1/2] Move support channels to a separate page and update Removing freenode due to takeover, etc. --- docs/Introduction.rst | 23 +++-------------------- docs/Support.rst | 28 ++++++++++++++++++++++++++++ index.rst | 1 + 3 files changed, 32 insertions(+), 20 deletions(-) create mode 100644 docs/Support.rst diff --git a/docs/Introduction.rst b/docs/Introduction.rst index f7525cb4f..27c887a8b 100644 --- a/docs/Introduction.rst +++ b/docs/Introduction.rst @@ -60,23 +60,6 @@ used by the DFHack console. background managing or changing some aspect of the game if you `enable` them. -.. _troubleshooting: -.. _support: - -Troubleshooting -=============== -Don't panic! Even if you need this section, it'll be OK :) - -If something goes wrong, check the log files in DF's folder -(``stderr.log`` and ``stdout.log``). Looking at these might help you - -or someone else - solve the problem. Take screenshots of any weird -error messages, and take notes on what you did to cause them. - -If the search function in this documentation isn't enough and -:wiki:`the DF Wiki <>` hasn't helped, try asking in: - -- the `#dfhack IRC channel on freenode `_ -- the `Bay12 DFHack thread `_ -- the `/r/dwarffortress `_ questions thread -- the thread for the mod or Starter Pack you're using (if any) - +Getting help +============ +There are several support channels available - see `support` for details. diff --git a/docs/Support.rst b/docs/Support.rst new file mode 100644 index 000000000..40b5f33a0 --- /dev/null +++ b/docs/Support.rst @@ -0,0 +1,28 @@ +.. _support: + +=============== +Getting Support +=============== + +DFHack has several ways to get help online, including: + +- The `DFHack Discord server `__ +- The ``#dfhack`` IRC channel on `Libera `__ +- The `DFHack thread on the Bay 12 Forum `__ + +Some additional, but less DFHack-specific, places where questions may be answered include: + +- The `/r/dwarffortress `_ questions thread on Reddit +- If you are using a starter pack, the relevant thread on the `Bay 12 Forum `__ - + see the :wiki:`DF Wiki ` for a list of these threads + +When reaching out to any support channels regarding problems with DFHack, please +remember to provide enough details for others to identify the issue. For +instance, specific error messages (copied text or screenshots) are helpful, as +well as any steps you can follow to reproduce the problem. Sometimes, log output +from ``stderr.log`` in the DF folder can point to the cause of issues as well. + +Some common questions may also be answered in documentation, including: + +- This documentation (`online here `__; search functionality available `here `) +- :wiki:`The DF wiki <>` diff --git a/index.rst b/index.rst index 4df56de58..2e5454f40 100644 --- a/index.rst +++ b/index.rst @@ -28,6 +28,7 @@ User Manual /docs/Introduction /docs/Installing + /docs/Support /docs/Core /docs/Plugins /docs/Scripts From 5d397ad0b0dfb4b9869dfe936b98cf51bb5de389 Mon Sep 17 00:00:00 2001 From: lethosor Date: Tue, 11 May 2021 19:46:01 -0400 Subject: [PATCH 2/2] [cherry-pick] Fix invalid role name Cherry-pick of 001e608aa72ec24002303740acd2061d3fe7e39f Conflicts (used version from master): docs/changelog.txt --- conf.py | 2 +- docs/Core.rst | 2 +- docs/Lua API.rst | 2 +- docs/guides/quickfort-user-guide.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/conf.py b/conf.py index d5ecc3a45..bf1dde2c4 100644 --- a/conf.py +++ b/conf.py @@ -209,7 +209,7 @@ extlinks = { 'bug': ('https://www.bay12games.com/dwarves/mantisbt/view.php?id=%s', 'Bug '), 'source': ('https://github.com/DFHack/dfhack/tree/develop/%s', ''), - 'source:scripts': ('https://github.com/DFHack/scripts/tree/master/%s', ''), + 'source-scripts': ('https://github.com/DFHack/scripts/tree/master/%s', ''), 'issue': ('https://github.com/DFHack/dfhack/issues/%s', 'Issue '), 'commit': ('https://github.com/DFHack/dfhack/commit/%s', 'Commit '), } diff --git a/docs/Core.rst b/docs/Core.rst index 4fdecbf63..cb4f8cf8f 100644 --- a/docs/Core.rst +++ b/docs/Core.rst @@ -492,7 +492,7 @@ the root DF folder. .. admonition:: Tip - When developing scripts in the :source:scripts:`dfhack/scripts repo <>`, + When developing scripts in the :source-scripts:`dfhack/scripts repo <>`, it may be useful to add the path to your local copy of the repo with ``+``. This will allow you to make changes in the repo and have them take effect immediately, without needing to re-install or copy scripts over manually. diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 764e56dd6..020bd2191 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -4377,7 +4377,7 @@ the extension omitted. For example: Scripts can also be placed in other folders - by default, these include :file:`raw/scripts` and :file:`data/save/{region}/raw/scripts`, but additional folders can be added (for example, a copy of the -:source:scripts:`scripts repository <>` for local development). See +:source-scripts:`scripts repository <>` for local development). See `script-paths` for more information on how to configure this behavior. If the first line of the script is a one-line comment (starting with ``--``), diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index 89d1d4997..b539279c3 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -1564,7 +1564,7 @@ Links - :source:`Quickfort blueprints library ` - :forums:`Quickfort forum thread <176889>` - :issue:`DFHack issue tracker <>` -- :source:scripts:`Quickfort source code ` +- :source-scripts:`Quickfort source code ` **Related tools:**