Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add helping section #196

Merged
merged 33 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
fb33ef9
panic commit: pc acting u
itscynxx Jun 22, 2023
61fee74
first "full" version
itscynxx Jun 22, 2023
f7728ef
add images to github repo instead of using github uploads
itscynxx Jun 22, 2023
4f0e4cd
much more polished version
itscynxx Jun 22, 2023
6cf6690
remove mod settings image because it'll be merged before this is lol
itscynxx Jun 22, 2023
a8f7c78
moving helping to its own file
itscynxx Jun 22, 2023
c086adc
Create helping.md
itscynxx Jun 22, 2023
d289b81
typo
itscynxx Jun 22, 2023
e4adc61
make images work in new file
itscynxx Jun 22, 2023
63e796c
Add helping to SUMMARY.md
itscynxx Jun 22, 2023
e188903
Keep spacer line
itscynxx Jun 22, 2023
2262e0a
Add plenty of newlines to helping.md
itscynxx Jun 22, 2023
48451e0
newlines made a 3 into a 5 lol
itscynxx Jun 22, 2023
eb4605a
Clarify why we use `ac`
itscynxx Jun 22, 2023
08bffa7
Update close delay timing, mention what Spectre is
itscynxx Jun 27, 2023
0c96905
update help guide, remove log reading (tepmorarily)
itscynxx Jul 21, 2023
254529f
this was meant to have a fresh line
itscynxx Jul 21, 2023
9ba9c6d
properly format birb and H0L0's names, add a new line to seperate the…
itscynxx Jul 21, 2023
e68a094
Merge branch 'main' into helping
GeckoEidechse Oct 25, 2023
755127f
Merge branch 'main' into helping
GeckoEidechse Oct 25, 2023
22a17d5
attempt to be better at the english language (grammar fixes)
itscynxx Oct 25, 2023
8288b8c
add a small bit on what tags are
itscynxx Oct 25, 2023
ee129f9
Apply grammar fixes from code review
itscynxx Oct 25, 2023
314a257
add tickets dashboard to ignorePatterns (md-linkcheck)
itscynxx Oct 25, 2023
5436218
typo
itscynxx Oct 25, 2023
318c82b
oh wait i bet it wants the format like this
itscynxx Oct 25, 2023
6282069
Merge branch 'main' into helping
GeckoEidechse Oct 25, 2023
a9f8b5c
Merge branch 'main' into helping
GeckoEidechse Oct 25, 2023
54c9ebd
Move Discord bots to subsections of `Miscellaneous`
itscynxx Dec 19, 2023
23a23a2
Apply suggestions from code review
GeckoEidechse Dec 19, 2023
30e9b4e
Merge branch 'main' into helping
GeckoEidechse Dec 19, 2023
b6f468d
Apply suggestions from code review
GeckoEidechse Dec 19, 2023
1855bfa
Merge branch 'main' into helping
GeckoEidechse Dec 19, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,6 @@

## Other

* [Helping](helping.md)
itscynxx marked this conversation as resolved.
Show resolved Hide resolved
* [Discord moderation](other/moderation.md)
* [Credits](other/credits.md)
85 changes: 85 additions & 0 deletions docs/helping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Helping

This section is meant mostly for those that will be actively helping others in the Northstar Discord server or otherwise.
If you've somehow stumbled upon this page trying to fix an issue for yourself, you should try checking the [troubleshooting page](installing-northstar/troubleshooting.md) instead.
If you're a helper, it also isn't a bad idea to look at this page a few times and try to have a rough idea of the things that are on it.

When helping a user, please try to move them to the `#help` channel to create a ticket as well as to keep public channels less cluttered.
itscynxx marked this conversation as resolved.
Show resolved Hide resolved

If they really don't want to open a ticket or you don't want to deal with a ticket, ask them to move to `#northstar-chat`.
There, not only can they embed things, but it'll be slightly more focused on helping than other channels would be.

Arguably the most important things to know as a helper are the ability to read logs and deal with users that don't read the wiki (90% of tickets are solutions solvable by checking the wiki.
There is a pretty high chance that even if the user claims they read the wiki they didn't actually do so or didn't find their issue on there)
itscynxx marked this conversation as resolved.
Show resolved Hide resolved

Reading logs is a little tougher however, but once you get the basics down you can easily diagnose issues in a few seconds after opening a log.
You can use `/tag id:logs` to inform users how to properly send a log in a Discord channel.
Generally, when reading a log there are a list of things you want to look for, which will be covered later.

The first section will first go over extremely common issues and their tags, then the basics of using the ticket bot for commands inside tickets, and then some overview and specific examples for reading logs.
itscynxx marked this conversation as resolved.
Show resolved Hide resolved

Additionally, please don't be afraid to ask for help. The entirety of `#volunteers-chat` in the Discord server is specifically for those that help/sometimes help users and there's no shame it not knowing.

## Common issues and their tags

In the Northstar Discord server, a massively used device to help end users is the tickets bot. A lot of the common issues and questions that come up have tags for them on the Discord server.
itscynxx marked this conversation as resolved.
Show resolved Hide resolved
The tag command for the tickets bot is `/tag`, and you can either type `/tag id:{TAG ID HERE}` or let the bot autofill the tag for you after typing `/tag` and selecting the tag id from the list (make sure you select the ticket bot, and not Dyno!).
Note, you can't reply to a user while using a slash command, so try to reply to the bot's message after sending the tag command while pinging the person it's directed at and informing them that they should follow the provided solution.

You can find a list of these tags on the [tag dashboard for the help bot](https://panel.ticketsbot.net/manage/920776187884732556/tags), so long as you sign in using your Discord account and have access to it with the roles that you have.
itscynxx marked this conversation as resolved.
Show resolved Hide resolved

## Ticket channel commands

This entire section only applies to users with `ticket-staff`+ roles who can see the ticket channels in the Discord server

The tickets have a fairly straightforward way of operating. When a user clicks on a button to open a ticket
(a staff ticket is only visible by helper+ roles, while a public ticket is visible by ticket-staff+ roles) they're greeted with the following screen:\
itscynxx marked this conversation as resolved.
Show resolved Hide resolved
![The information fields for opening a ticket](images/ticket-information-popup.png)

They will fill this out with information which will later be shared in their ticket as a message sent as an embed by the ticket bot.
This will be the first message in the channel and will look something similar to this:\
![The embed sent in a ticket with the information filled out by the user](images/ticket-open-message.png)

Note the buttons below the embed.\
Hitting `Close` will close the ticket without a reason for closing it.\
`Close with reason` will let you give a reason as to why you closed the ticket.\
`Claim` allows you to "claim" a ticket and lets other helpers know that you'll be solving the ticket.
This doesn't usually get used for Northstar, however people can still message in the channel even after it's claimed so don't worry if you accidentally claim a ticket/end up not being able to solve it.

These buttons, however, are not always easy to scroll back up to, especially if the ticket has been open for a while. This is where slash commands come in.

There are 3 major slash commands for tickets. These are `/close`, `/closerequest`, and `/add`.

`/close` by itself will close the ticket immediately, without a reason. Using a slash command however, you can give a reason for closing using the `reason` option for the slash command.

`/add` will add a normal (non ticket-viewing) user to a ticket. This is useful if, for example, someone who created a mod and can't see the tickets has one of their mods create an error for a user and you can't diagnose it. This is also useful for cases where someone opens a ticket for someone else.

You may have noticed that `/closerequest` has been skipped. That's because there's sort of a "etiquette" surrounding it.

Generally, you _should_ use `/closerequest` for closing a ticket. There's much less chance the end user gets upset, and it can be denied last minute if another issue comes up.\
![What using the `/closerequest` command looks like](images/closerequest.png)

From here, the user can accept the close request, which in turn closes the ticket, or deny the close request, while results in an edited embed telling you they denied it.

To _use_ the `/closerequest` command, there are a few "ways" to use it.\
Note that `close_delay` is a number, meaning the time in hours before the ticket autocloses.\
`reason` is a box to input the reason for a close request.\
Using "ac" as described later lets other people know how long until the ticket will close ("ac" meaning **A**uto **C**lose). This helps yourself and others when looking at tickets because the tickets bot doesn't show when a ticket is set to auto close.

If the ticket seems resolved/the user has said they have no issues, use `/closerequest` with `close_delay` set to `8` and the `reason` set to "resolved, ac 8hr"
GeckoEidechse marked this conversation as resolved.
Show resolved Hide resolved

For tickets where the end user that opened the ticket _never_ responded, we usually wait a couple days, ping them a few times, and if they continue to be inactve, set a close request with `close_delay` set to 24 and the `reason` set to "no response, ac 24hr"
For inactive tickets (when it's the _user_ not responding, not us!) we usually give them a few days (3-5 days, sometimes longer if we forget_) and then start pinging them once a day.
If they continue to not respond for 2-3 days, we tend to set a close request with `close_delay` set to `48` and the `reason` set to "inactive ticket, ac 48hr"

You can also use `/closerequest` without giving a `close_delay` or a `reason`, however you should always try to give a reason for closing a ticket, and if you don't give a `close_delay` there's a high chance that the ticket doesn't get closed (quite a few end users don't accept or see the close request)

You can view information on the closed tickets, such as open and close date, who opened the ticket, who closed the ticket, and the reason for closing the ticket in the `#transcripts` channel. The bot also provides an online log of the entire ticket connected to the embed when a ticket is closed.
GeckoEidechse marked this conversation as resolved.
Show resolved Hide resolved

## Miscellaneous

The Northstar Discord server also has a couple custom bots in it. These are:

birb and H0L0's bot [Northstar Servers](https://github.com/hummusbird/northstar-bot), which allows you to run commands like `.status` and see how many people are online on Northstar currently, and things such as `.search region aus`, which would search servers with the region Australia. You can check the repo for more info.

Cyn's bot [Spectre](https://github.com/CooldudePUGS/Spectre) automatically replies to specific error messages, which you can see a list of [here](https://github.com/CooldudePUGS/Spectre/wiki/Replies), as well as SOME automatic log parsing.
Binary file added docs/images/closerequest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/compile-error-ClientKillCallback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/compile-error-updatemod.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/conflicting-sounds-dump-part1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/conflicting-sounds-dump-part2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/crash-dump-part1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/crash-dump-part2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/multiple-crash-messages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ticket-information-popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ticket-open-message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.