Skip to content

Commit

Permalink
docs: update readme, privacy, and tos (#205)
Browse files Browse the repository at this point in the history
  • Loading branch information
CarelessInternet authored Jun 20, 2022
1 parent c3aeaa2 commit 2534251
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 14 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,9 @@ Run the command `npm start` to run the bot.

## Issues

If you can't get the bot to run, join the [support server](https://discord.gg/kswKHpJeqC) and create a support ticket in `#support`.<br>
If you can't get the bot to run, join the [support server](https://discord.gg/kswKHpJeqC) and create a support ticket.<br>
For any bug reports, suggestions or general feedback, please submit an issue or join the support server.

## Pull Requests

If you found any bug and created code to solve it, or updated anything important, feel free to submit a pull request so I can merge it into the main branch.<br>
You can also submit a pull request if you made a new command and want it to be a part of the bot.
If you updated or created anything that benefits the bot, feel free to submit a pull request to be merged into the main branch.
33 changes: 25 additions & 8 deletions privacy_policy.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Disclaimer

The information here may not always be up to date. If it isn't up to date, feel free to join the [support server](https://discord.gg/kswKHpJeqC) and say so or open an issue here on GitHub.<br>
Last Updated: 09 June, 2022
Last Updated: 20 June, 2022

## What do you mean by "Discord Data?"

Expand All @@ -25,32 +25,49 @@ As of right now, Ticketer collects one of the following Discord Data requested t
- Guild ID
- Channel ID

## What other optional data is stored/created?
### What other optional data is stored/created?

As of right now, Ticketer collects/creates the following data requested through a command:

- Ticketing Config Commands:
- Channel(s) ID (optional specified support channel, logs channel or support category channel)
- True/False for whether the reply should be shown or hidden (Reply Embeds)
- True/False for whether text channels should be used instead of threads
- True/False for whether the ticket should ping the ticketing managers in text channels
- A description of the "notes" for tickets, optional comments that should be displayed in the ticket
- A customized description for ticket panels
- Welcome/Goodbye Config Commands:
- Enabled (to enable or disable the welcome/goodye messages)
- Suggestions Commands:
- True/False for whether the reply should be shown or hidden (Reply Embeds)
- Amount of reactions needed to pin a suggestion
- User IDs for blocking/unblocking users from using the `suggest` command
- A customized description for suggestion panels

## Why do you need the data?

All of the data collected is required to keep the commands and functionality provided by Ticketer working as expected.

## How do you use the data?

The ticketing data is used to know what server the data belongs to, the role to invite to each new support ticket, optionally the channel for tickets, optionally the logs channel to send logs to, optionally to ping managers in a text channel, optionally the notes to display, and optionally whether to send an ephemeral reply on successfully creating a ticket.<br>
The welcome/goodbye messages is used to greet or say goodbye to an incoming or leaving user. The data is used to know which server and channel to send it to, and optionally whether or not to enable the messages.<br>
The suggestions data is used to know what server the data belongs to, the channel for suggestions to be sent to, optionally the amount of reactions needed to pin a suggestion, optionally whether to send a reply embed or ephemeral reply on successfully creating a suggestion, and optionally preventing users from using the suggestions commands if they are blocked.
The ticketing data is used to know/do the following:
- What server the data belongs to
- The role to invite to each new support ticket
- Optionally the channel for tickets
- Optionally the logs channel to send logs to
- Optionally to ping managers in a text channel
- Optionally the notes to display under each ticket
- Optionally the information to display in ticket panels


The welcome/goodbye data is used to know the following:
- What server and channel to send the greeting/farewell to
- Optionally whether or not to enable the messages


The suggestions data is used to know the following:
- What server the data belongs to
- The channel for suggestions to be sent to
- Optionally the amount of reactions needed to pin a suggestion
- Optionally the information to display in suggestion panels

## How long is the data stored for?

Expand All @@ -62,7 +79,7 @@ No data is shared with anyone or any companies.

## How can users contact you if they have concerns about your bot?

They may join the official support server, or open an issue on GitHub.
They may join the official support server to discuss such concerns, or open an issue on GitHub.

## How can users have the data removed?

Expand Down
6 changes: 3 additions & 3 deletions terms_of_service.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Terms of Service

Last Updated: 09 June, 2022
Last Updated: 20 June, 2022

Looking for the [privacy policy](https://github.com/CarelessInternet/Ticketer/blob/main/privacy_policy.md)?

Expand All @@ -10,9 +10,9 @@ By using Ticketer, you are agreeing to both the privacy policy and terms of serv

Message logs are created when ticket logs are toggled on. These message logs are sent to the ticket author and the logs channel when the ticket gets deleted through the `delete` command. Ticketer does not verify nor filter content in support tickets. You, the user, are responsible for any content delivered by you in support tickets, including message log histories. Ticketer cannot remove content in the message logs after they have been posted. Please be careful of what you post in support tickets.

## Ticket Notes
## Ticket Notes and Panels

The same idea for message logs applies here. You are responsible for the content you created for in ticket notes. Ticketer doesn't filter nor verify the content posted.
The same idea for message logs applies here. You are responsible for the content you created for in ticket notes and panels. Ticketer doesn't filter nor verify the content posted.

## Suggestions

Expand Down

0 comments on commit 2534251

Please sign in to comment.