Skip to content

Commit

Permalink
Further doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
skleinei committed Sep 6, 2022
1 parent c6a556a commit 0c43854
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ In order to get started:
[Github releases page](https://github.com/skleinei/alfred-confluence/releases).
2. Double click the downloaded file to install the workflow in Alfred.
3. In the workflow configuration:
* **Atlassian URL** - enter the Confluence Base URL, e.g. https://amce.atlassian.net (if you
* **URL** - enter the Confluence Base URL, e.g. https://amce.atlassian.net (if you
have a really old Atlassian URL it could also be something like https://amce.jira.com)
* **Email** - enter the email adress of your Atlassian ID account
* **Token** - enter an API token for Confluence. (Generate it here:
* **API Token** - enter an API token for Confluence. (Generate it here:
https://id.atlassian.com/manage/api-tokens)

To search for Confluence content, open Alfred with `⌘Space` and enter `c <search term>`.
Expand All @@ -34,7 +34,11 @@ for Alfred* supports in a straight forward way, bu duplicating the workflow in A

To search in a second Confluence instance:
1. Right-click the Confluence Quicksearch workflow and **Duplicate**.
1. Click **Configure Workflow** and change the URL in the configuration.
2. Click **Configure Workflow** and change the URL in the configuration.
3. Double click the Script Filter element and change the keyword from `c` to something else like `co`.

To search for content in the other Confluence system, you can then enter `co <search term>`.


Please note that you have to re-do this, everytime when you install a new version of *Confluence
Quicksearch for Alfred*, because only the orginial version will be upgraded.
Expand Down
18 changes: 8 additions & 10 deletions src/info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -114,18 +114,16 @@ The *Confluence Quicksearch* workflow let's you search, open, and edit Confluenc
## Getting Started
You are almost there.
You are almost there. To complete the installation:
### To complete the installation:
1. Enter the following details (on the right side of this window):
- **URL** of your Atlassian cloud instance, for example: https://amce.atlassian.net
- **Email** used in your Atlassian account
- **Atlassian API token**, which you can get in your [Atlassian ID account](https://id.atlassian.com/manage/api-tokens)
1. In the workflow configuration (on the right side):
* **URL** - enter the URL of your Atlassian Cloud, e.g. https://amce.atlassian.net (if you have a really old Atlassian URL it could also be something like https://amce.jira.com)
* **Email** - enter the email adress of your Atlassian ID account
* **API Token** - enter an API token for Confluence. (Generate it here: https://id.atlassian.com/manage/api-tokens)
2. Click **Import**.
### After that you are ready to go:
1. Launch Alfred with `⌘ Space` (or however you have Alfred's keyboard shortcut configured)
2. Enter `c search term`
To search for Confluence content, open Alfred with `⌘Space` and enter `c search term`.
## More Information
Expand Down Expand Up @@ -207,7 +205,7 @@ Get more information and latest releases on https://github.com/skleinei/alfred-c
<key>description</key>
<string>Generate at: https://id.atlassian.com/manage/api-tokens</string>
<key>label</key>
<string>Atlassian API Token</string>
<string>API Token</string>
<key>type</key>
<string>textfield</string>
<key>variable</key>
Expand Down

0 comments on commit 0c43854

Please sign in to comment.