Browse Source

Merge pull request #1058 from trapexit/docs

Support doc update
pull/1085/head
trapexit 2 years ago
committed by GitHub
parent
commit
5d3c5002e0
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 10
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 4
      .github/ISSUE_TEMPLATE/question.md
  3. 4
      README.md
  4. 7
      man/mergerfs.1

10
.github/ISSUE_TEMPLATE/bug_report.md

@ -9,7 +9,9 @@ assignees: ''
**Describe the bug**
A clear and concise description of the unexpected behavior. Please be sure to use latest release of mergerfs to ensure the issue still exists.
A clear and concise description of the unexpected behavior.
**Please be sure to use latest release of mergerfs to ensure the issue still exists. Not your distro's latest but the latest official release.**
The master branch is **not** to be considered production ready. Feel free to file bug reports but do so indicating clearly that you are testing unreleased code.
@ -18,9 +20,9 @@ The master branch is **not** to be considered production ready. Feel free to fil
Steps to reproduce the behavior. List **all** steps to reproduce. **All** settings.
Please simplify the reproduction as much as possible.
Please simplify the reproduction as much as possible.
- Unless it is dependenat on multiple branches, use a single branch
- Use standard tooling if possible (touch,truncate,rm,rmdir,ln,etc.)
- Reproduce with standard tooling if possible (touch,truncate,rm,rmdir,ln,etc.) Having to install 3rd party software will make debugging more difficult.
**Expected behavior**
@ -36,7 +38,7 @@ A clear and concise description of the expected behavior.
- List of drives, filesystems, & sizes:
- `df -h`
- `lsblk -f`
- A strace of the application having a problem:
- A strace of the application having a problem:
- `strace -fvTtt -s 256 -o /tmp/app.strace.txt <cmd>`
- `strace -fvTtt -s 256 -o /tmp/app.strace.txt -p <appPID>`
- strace of mergerfs while app tried to do it's thing:

4
.github/ISSUE_TEMPLATE/question.md

@ -1,10 +1,10 @@
---
name: Question
about: When you're looking for information
about: When you're looking for information or general support
title: ''
labels: investigating, question
assignees: ''
---
You can also ask questions on Discord for realtime help: https://discord.gg/MpAr69V
For general questions and support please use [GitHub Discussions](https://github.com/trapexit/mergerfs/discussions) or [Discord](https://discord.gg/MpAr69V).

4
README.md

@ -1291,6 +1291,8 @@ Filesystems are complex and difficult to debug. mergerfs, while being just a pro
**Please make sure you are using the [latest release](https://github.com/trapexit/mergerfs/releases) or have tried it in comparison. Old versions, which are often included in distros like Debian and Ubuntu, are not ever going to be updated and your bug may have been addressed already.**
**For commercial support or feature requests please contact me directly.**
#### Information to include in bug reports
@ -1320,7 +1322,7 @@ Filesystems are complex and difficult to debug. mergerfs, while being just a pro
#### Support development
This software is free to use and released under a very liberal license (ISC). That said if you like this software and have the means please consider supporting its development.
This software is released under the very liberal ISC license and is therefore free to use for personal or commercial uses. That said if you like this software and have the means please consider supporting its development.
https://github.com/trapexit/support

7
man/mergerfs.1

@ -2751,6 +2751,9 @@ release (https://github.com/trapexit/mergerfs/releases) or have tried it
in comparison. Old versions, which are often included in distros like
Debian and Ubuntu, are not ever going to be updated and your bug may
have been addressed already.\f[R]
.PP
\f[B]For commercial support or feature requests please contact me
directly.\f[R]
.SS Information to include in bug reports
.IP \[bu] 2
Version of mergerfs: \f[C]mergerfs \-V\f[R]
@ -2802,8 +2805,8 @@ twitter: https://twitter.com/_trapexit
reddit: https://www.reddit.com/user/trapexit
.SS Support development
.PP
This software is free to use and released under a very liberal license
(ISC).
This software is released under the very liberal ISC license and is
therefore free to use for personal or commercial uses.
That said if you like this software and have the means please consider
supporting its development.
.PP

Loading…
Cancel
Save