Skip to content

Commit 5ef8c36

Browse files
setchysetchy
committed
docs: add faq for filter behavior
Signed-off-by: Adam Setch <[email protected]>
1 parent 04d3ad3 commit 5ef8c36

File tree

7 files changed

+62
-48
lines changed

7 files changed

+62
-48
lines changed

‎src/faqs/1.md‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2-
title: "My notifications aren't showing?"
2+
title: "How do Filters work?"
33
---
4-
When authenticating via **Personal Access Token (PAT)**:
5-
- open [GitHub Developer Settings >> Tokens](https://github.com/settings/tokens)
6-
- confirm that your PAT has the following recommended permissions: `notifications`, `read:user` and `repo`
7-
- Note: if you only want Gitify to access public repositories, you can use permissions: `notifications`, `read:user` and `public_repo`
8-
9-
When authenticating via **Gitify GitHub App**:
10-
- some organizations require GitHub Apps to request access prior to allowing access to organization data (including notifications)
11-
- to check if Gitify is approved by your organization open [GitHub Developer Settings >> GitHub Apps](https://github.com/settings/applications), then click on _Gitify_ and scroll to _Organization access_
4+
5+
Filters in Gitify help you manage which notifications are shown in the app, allowing you to concentrate on the most crucial ones for your workflow.
6+
7+
<br />
8+
9+
Filters can be accessed from the Gitify sidebar. By default, all notifications are shown.
10+
11+
<br />
12+
13+
If you apply filters, your inbox will display notifications based on a `LOGICAL AND` condition.
14+

‎src/faqs/2.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: "How to configure OAuth App authentication?"
2+
title: "My notifications aren't showing?"
33
---
4-
To authenticate via an **OAuth App**:
5-
- create a new application within _GitHub → Settings → Developer settings → OAuth Apps_.
6-
- Set _Authorization callback URL_ as `gitify://oauth`
7-
- Complete all remaining mandatory fields
8-
- Click _Register application_
9-
- Now click on _Generate a new client secret_
10-
- Use this client/secret pair within Gitify to authenticate.
4+
When authenticating via **Personal Access Token (PAT)**:
5+
- open [GitHub Developer Settings >> Tokens](https://github.com/settings/tokens)
6+
- confirm that your PAT has the following recommended permissions: `notifications`, `read:user` and `repo`
7+
- Note: if you only want Gitify to access public repositories, you can use permissions: `notifications`, `read:user` and `public_repo`
8+
9+
When authenticating via **Gitify GitHub App**:
10+
- some organizations require GitHub Apps to request access prior to allowing access to organization data (including notifications)
11+
- to check if Gitify is approved by your organization open [GitHub Developer Settings >> GitHub Apps](https://github.com/settings/applications), then click on _Gitify_ and scroll to _Organization access_

‎src/faqs/3.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
title: "What does 'Unsubscribe from Thread' mean?"
2+
title: "How to configure OAuth App authentication?"
33
---
4-
When you **Unsubscribe from Thread**, you will not receive future notifications for the thread until you either comment on the thread or get a **@mention**.
5-
6-
<br />
7-
8-
_Note: If you are watching a repository, you receive notifications for all threads by default._
4+
To authenticate via an **OAuth App**:
5+
- create a new application within _GitHub → Settings → Developer settings → OAuth Apps_.
6+
- Set _Authorization callback URL_ as `gitify://oauth`
7+
- Complete all remaining mandatory fields
8+
- Click _Register application_
9+
- Now click on _Generate a new client secret_
10+
- Use this client/secret pair within Gitify to authenticate.

‎src/faqs/4.md‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
---
2-
title: "Something is not working as expected, how can I debug Gitify?"
2+
title: "What does 'Unsubscribe from Thread' mean?"
33
---
4-
Using **Chrome Developer Tools** (console logs, network requests, etc):
5-
- All platforms: right click tray icon then _Developer → Toggle Developer Tools_
6-
- macOS: `command + opt + i`
7-
- Windows: `ctrl + shift + i`
8-
- Linux: `ctrl + shift + i`
4+
When you **Unsubscribe from Thread**, you will not receive future notifications for the thread until you either comment on the thread or get a **@mention**.
95

106
<br />
117

12-
Using **Application Log Files**:
13-
- All platforms: right click tray icon then _Developer → View Application Logs_
14-
- macOS: `~/Library/Logs/gitify`
15-
- Windows: `%USERPROFILE%\\AppData\\Roaming\\gitify\\logs`
16-
- Linux: `~/.config/gitify/logs`
8+
_Note: If you are watching a repository, you receive notifications for all threads by default._

‎src/faqs/5.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: "How do I fix 'Chrome Sandbox' permissions on Linux?"
2+
title: "Something is not working as expected, how can I debug Gitify?"
33
---
4-
If you experience issues opening Gitify on Linux due to `Chrome Sandbox` permissions, try running the following commands:
5-
6-
```
7-
sudo chown root:root /opt/Gitify/chrome-sandbox
8-
sudo chmod 4755 /opt/Gitify/chrome-sandbox
9-
```
4+
Using **Chrome Developer Tools** (console logs, network requests, etc):
5+
- All platforms: right click tray icon then _Developer → Toggle Developer Tools_
6+
- macOS: `command + opt + i`
7+
- Windows: `ctrl + shift + i`
8+
- Linux: `ctrl + shift + i`
109

1110
<br />
1211

13-
To check for startup errors
14-
```
15-
journalctl -xe | grep gitify
16-
```
12+
Using **Application Log Files**:
13+
- All platforms: right click tray icon then _Developer → View Application Logs_
14+
- macOS: `~/Library/Logs/gitify`
15+
- Windows: `%USERPROFILE%\\AppData\\Roaming\\gitify\\logs`
16+
- Linux: `~/.config/gitify/logs`

‎src/faqs/6.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: "How can I contribute to Gitify?"
2+
title: "How do I fix 'Chrome Sandbox' permissions on Linux?"
33
---
4-
You can contribute to Gitify by opening an issue or pull request on GitHub at [gitify-app/gitify](https://github.com/gitify-app/gitify).
4+
If you experience issues opening Gitify on Linux due to `Chrome Sandbox` permissions, try running the following commands:
5+
6+
```
7+
sudo chown root:root /opt/Gitify/chrome-sandbox
8+
sudo chmod 4755 /opt/Gitify/chrome-sandbox
9+
```
510

611
<br />
712

8-
Check out our [open issues](https://github.com/gitify-app/gitify/issues) and see if there is any existing ideas that you would like to work on.
13+
To check for startup errors
14+
```
15+
journalctl -xe | grep gitify
16+
```

‎src/faqs/7.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "How can I contribute to Gitify?"
3+
---
4+
You can contribute to Gitify by opening an issue or pull request on GitHub at [gitify-app/gitify](https://github.com/gitify-app/gitify).
5+
6+
<br />
7+
8+
Check out our [open issues](https://github.com/gitify-app/gitify/issues) and see if there is any existing ideas that you would like to work on.

0 commit comments

Comments
 (0)