-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update link formatting and faqs
Signed-off-by: Adam Setch <[email protected]>
- Loading branch information
Showing
4 changed files
with
65 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,55 @@ | ||
| import { SolidMarkdown } from 'solid-markdown'; | ||
| import { SolidMarkdown } from "solid-markdown"; | ||
| import { | ||
| Accordion, | ||
| AccordionContent, | ||
| AccordionItem, | ||
| AccordionTrigger, | ||
| } from '~/components/ui/Accordion'; | ||
| import { siteMetadata } from '~/constants'; | ||
| Accordion, | ||
| AccordionContent, | ||
| AccordionItem, | ||
| AccordionTrigger, | ||
| } from "~/components/ui/Accordion"; | ||
| import { siteMetadata } from "~/constants"; | ||
|
|
||
| const content = [ | ||
| { | ||
| id: '1', | ||
| question: "My notifications aren't showing?", | ||
| answer: | ||
| "Some organizations require applications to request access before allowing access to any data (including notifications) about their repositories.\n\nTo check if Gitify is approved by your organisation you can go to [settings](https://github.com/settings/applications), then click on **Gitify** and scroll to **Organization access**.\n\nAlternatively, if you generated a **PAT**, you can check if it has the correct permissions by going to [settings](https://github.com/settings/tokens) and checking if the token's SSO has been Authorized.", | ||
| }, | ||
| { | ||
| id: '2', | ||
| question: 'GitHub Enterprise Server - Authorizing via OAuth?', | ||
| answer: | ||
| 'If you want to use OAuth to authenticate with Gitify, first create a new application within _**GitHub** → **Settings** → **Developer settings** → **OAuth Apps**_.\n\nComplete all the fields, ensuring you use https://www.gitify.io/callback as the _**Authorization callback URL**_. Once saved, click on _**Generate a new client secret**_ to get a client/secret pair that you can use with Gitify.', | ||
| }, | ||
| { | ||
| id: '3', | ||
| question: 'Unsubscribe from Thread - What does this mean?', | ||
| answer: | ||
| '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**.\n\n_Note: If you are watching a repository, you receive notifications for all threads by default._', | ||
| }, | ||
| { | ||
| id: '4', | ||
| question: 'Something looks wrong - How can I debug?', | ||
| answer: | ||
| 'You can debug Gitify by pressing:\n- macOS: `command + opt + i`\n- Windows + Linux: `ctrl + shift + i`\n\nThis will open the dev tools and then you can see any logs, network requests etc.', | ||
| }, | ||
| { | ||
| id: '5', | ||
| question: 'Are there local log files?', | ||
| answer: | ||
| 'There sure is! You can find them on your device at:\n- macOS: `~/Library/Logs/gitify`\n- Windows: `%USERPROFILE%\\AppData\\Roaming\\gitify`.', | ||
| }, | ||
| { | ||
| id: '6', | ||
| question: 'How can I contribute to Gitify?', | ||
| answer: `You can contribute to Gitify by opening a pull request @[${siteMetadata.repo}](https://github.com/${siteMetadata.repo})! Check out our open issues and see if there's anything you'd like to work on.`, | ||
| }, | ||
| { | ||
| id: "1", | ||
| question: "My notifications aren't showing?", | ||
| answer: | ||
| "When authenticating via **Personal Access Token (PAT)**:\n- open [GitHub Developer Settings >> Tokens](https://github.com/settings/tokens)\n- confirm that your PAT has the following permissions: `notifications`, `read:user` and `repo`\n\nWhen authenticating via **Gitify GitHub App**:\n- some organizations require GitHub Apps to request access prior to allowing access to organization data (including notifications)\n- 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_", | ||
| }, | ||
| { | ||
| id: "2", | ||
| question: "How to configure OAuth App authentication?", | ||
| answer: | ||
| "To authenticate via an **OAuth App**:\n- create a new application within _GitHub → Settings → Developer settings → OAuth Apps_.\n- Set _Authorization callback URL_ as `https://www.gitify.io/callback`\n- Complete all remaining mandatory fields\n- Click _Register application_\n- Now click on _Generate a new client secret_\n- Use this client/secret pair within Gitify to authenticate.", | ||
| }, | ||
| { | ||
| id: "3", | ||
| question: "What does 'Unsubscribe from Thread' mean?", | ||
| answer: | ||
| "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**.\n\n_Note: If you are watching a repository, you receive notifications for all threads by default._", | ||
| }, | ||
| { | ||
| id: "4", | ||
| question: "Something is not working as expected, how can I debug Gitify?", | ||
| answer: | ||
| "Using **Chrome Developer Tools** (console logs, network requests, etc):\n- All platforms: right click tray icon then _Developer → Toggle Developer Tools_\n- macOS: `command + opt + i`\n- Windows + Linux: `ctrl + shift + i`\n\nUsing **Application Log Files**:\n- macOS: `~/Library/Logs/gitify`\n- Windows: `%USERPROFILE%\\AppData\\Roaming\\gitify`", | ||
| }, | ||
| { | ||
| id: "6", | ||
| question: "How can I contribute to Gitify?", | ||
| answer: `You can contribute to Gitify by opening an issue or pull request on GitHub at [${siteMetadata.repo}](https://github.com/${siteMetadata.repo}).\n\nCheck out our [open issues](https://github.com/${siteMetadata.repo}/issues) and see if there is any existing ideas that you would like to work on.`, | ||
| }, | ||
| ]; | ||
|
|
||
| export const FaqAccordion = () => { | ||
| return ( | ||
| <Accordion multiple collapsible> | ||
| {content.map((item) => ( | ||
| <AccordionItem value={item.id}> | ||
| <AccordionTrigger>{item.question}</AccordionTrigger> | ||
| <AccordionContent> | ||
| <SolidMarkdown children={item.answer} class="markdown" /> | ||
| </AccordionContent> | ||
| </AccordionItem> | ||
| ))} | ||
| </Accordion> | ||
| ); | ||
| return ( | ||
| <Accordion multiple collapsible> | ||
| {content.map((item) => ( | ||
| <AccordionItem value={item.id}> | ||
| <AccordionTrigger>{item.question}</AccordionTrigger> | ||
| <AccordionContent> | ||
| <SolidMarkdown children={item.answer} class="markdown" /> | ||
| </AccordionContent> | ||
| </AccordionItem> | ||
| ))} | ||
| </Accordion> | ||
| ); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters