Skip to content

Commit

Permalink
docs: Add BRAT installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
andymac4182 committed Apr 16, 2023
1 parent 633e495 commit a46cd23
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/src/getting-started/installation-brat.md
@@ -0,0 +1,20 @@
# Installing plugin using Obsidian42-BRAT

To install the `obsidian-confluence` plugin using [Obsidian42-BRAT](https://github.com/TfTHacker/obsidian42-brat#Quick-Guide-for-using-BRAT), follow these steps:

## Adding a beta plugin

1. Install **BRAT** from the Community Plugins in Obsidian.
2. Get the link to the GitHub repository you want to test. The plugin developer can provide you with this link.
For the `obsidian-confluence` plugin, use this link: https://github.com/obsidian-confluence/obsidian-confluence
3. Open the command palette and run the command `BRAT: Add a beta plugin for testing`
4. Using the link from step 2, copy that into the modal that opens up.
5. Click on **Add Plugin** -- wait a few seconds and BRAT will tell you what is going on.
6. After BRAT confirms the installation, in Settings go to the **Community plugins** tab.
7. Refresh the list of plugins.
8. Find the beta plugin you just installed (`obsidian-confluence`) and **Enable** it.

## Updating beta plugins

- Plugins can be updated using the command palette by running the command `Check for updates to all beta plugins and UPDATE`.
- Optionally, beta plugins can be configured to auto-update when starting Obsidian. This feature can be enabled in the **Obsidian42- BRAT** tab in settings.
7 changes: 7 additions & 0 deletions docs/src/getting-started/installation.md
@@ -1,3 +1,10 @@

# Alternative Installation
Due to waiting for https://github.com/obsidianmd/obsidian-releases/pull/1867 to be merged.

If you would like to use the plugin currently you will need to use [Alternative Installation](./installation-brat.md) instructions.

# Installation
1. Install the `confluence-integration` plugin from Obsidian's community plugins browser.
2. Open the plugin settings and configure the following fields:
- `Confluence Base URL`: The base URL of your Atlassian Confluence instance (e.g., `https://your-domain.atlassian.net`)
Expand Down

0 comments on commit a46cd23

Please sign in to comment.