diff --git a/fern/docs.yml b/fern/docs.yml index cdf691e..20dbde4 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -57,6 +57,8 @@ navigation: path: ./docs/configuration/context-sources/linear.md - page: Jira path: ./docs/configuration/context-sources/jira.md + - page: Confluence + path: ./docs/configuration/context-sources/confluence.md - section: Doc Collections path: ./docs/configuration/doc-collections.md contents: @@ -80,8 +82,6 @@ navigation: path: ./docs/features/github-pr-comments.mdx - page: Using the Web Interface path: ./docs/features/web-ui-feedback.mdx - - page: Providing Feedback - path: ./docs/features/providing-feedback.mdx - section: Integrations icon: fa-regular fa-plug path: ./docs/integrations/index.mdx @@ -94,9 +94,9 @@ navigation: - page: GitHub Enterprise Integration path: ./docs/integrations/github-enterprise.mdx slug: github-enterprise-integration - - page: Jira Integration - path: ./docs/integrations/jira.mdx - slug: jira-integration + - page: Atlassian Integration + path: ./docs/integrations/atlassian.mdx + slug: atlassian-integration - page: Linear Integration path: ./docs/integrations/linear.mdx slug: linear-integration diff --git a/fern/docs/configuration/context-sources.md b/fern/docs/configuration/context-sources.md index dd4e205..dc8bf6a 100644 --- a/fern/docs/configuration/context-sources.md +++ b/fern/docs/configuration/context-sources.md @@ -22,6 +22,10 @@ Context sources are **optional** but highly recommended. They can significantly Query Jira tickets and project data using JQL search capabilities + + + Search Confluence spaces for existing documentation patterns, terminology, and architectural decisions + ## Examples @@ -34,6 +38,10 @@ When a GitHub PR mentions a new feature, Promptless searches Linear for related If a GitHub PR references a Jira ticket (like "PROJ-123"), Promptless automatically reads that Jira ticket for additional context. It also proactively searches Jira using JQL for related issues and epics. +### Confluence as a Context Source + +When writing documentation, Promptless searches your Confluence spaces for existing documentation patterns, terminology, and architectural decisions. This ensures new documentation matches your team's existing style and conventions. + ## Configuring Context Sources Context sources are configured at the project level in your [projects page](https://app.gopromptless.ai/projects). For each project, you can: diff --git a/fern/docs/configuration/context-sources/confluence.md b/fern/docs/configuration/context-sources/confluence.md new file mode 100644 index 0000000..c821c32 --- /dev/null +++ b/fern/docs/configuration/context-sources/confluence.md @@ -0,0 +1,38 @@ +--- +title: Confluence +--- + +Confluence integration provides access to your documentation spaces for documentation automation. When Confluence is configured as a context source, Promptless can search your Confluence spaces for relevant documentation when creating suggestions. + +## How It Works as Context Source + +When Confluence is enabled as a context source: + +- **Automatic Space Searching**: Promptless searches your Confluence spaces for relevant documentation when creating suggestions +- **Documentation Patterns**: Confluence pages provide context about existing documentation styles, terminology standards, and content structures +- **Architectural Context**: Technical specifications, design decisions, and system architecture documented in Confluence inform new documentation +- **Team Knowledge**: Internal processes, guidelines, and best practices from your team's Confluence spaces + +## Example + +When writing API documentation, Promptless searches your Confluence spaces for existing API design patterns, naming conventions, and architectural decisions. This ensures new documentation matches your existing terminology and structure. For instance, if your team documents all API endpoints using a specific format in Confluence, Promptless will follow that same pattern when creating new API documentation. + +## Configuration + +Configure Confluence context in your [project settings](https://app.gopromptless.ai/projects): + +1. Enable Confluence as a context source for your project +2. Select which Confluence spaces Promptless can search within +3. Promptless will only search spaces you explicitly configure + + +Promptless inherits the permissions of the Atlassian account used during OAuth connection and will only search spaces you configure in your project settings. + + +## Data Privacy + +Promptless queries Confluence data in real-time and does not store any of your Confluence data. All searches are performed on-demand when documentation updates are needed. + +## Setup Instructions + +To connect Confluence to Promptless, see the [Atlassian Integration](/docs/integrations/atlassian-integration) setup guide. diff --git a/fern/docs/configuration/context-sources/jira.md b/fern/docs/configuration/context-sources/jira.md index 7a93da3..15dd792 100644 --- a/fern/docs/configuration/context-sources/jira.md +++ b/fern/docs/configuration/context-sources/jira.md @@ -40,8 +40,8 @@ Promptless inherits the permissions of the Jira account used during OAuth connec Promptless queries Jira data in real-time and does not store any of your Jira data. All searches are performed on-demand when documentation updates are needed. -For information about data processing and redaction capabilities, see the Jira integration page. +For information about data processing and redaction capabilities, see the Atlassian integration page. ## Setup Instructions -To connect Jira to Promptless, see the [Jira Integration](/docs/integrations/jira-integration) setup guide. +To connect Jira to Promptless, see the [Atlassian Integration](/docs/integrations/atlassian-integration) setup guide. diff --git a/fern/docs/getting-started.mdx b/fern/docs/getting-started.mdx index edfb17e..e11efad 100644 --- a/fern/docs/getting-started.mdx +++ b/fern/docs/getting-started.mdx @@ -27,7 +27,7 @@ Visit the [Integrations page](https://app.gopromptless.ai/integrations) in your - **GitHub repos**: Most common setup. Supports many hosting providers like ReadMe, Mintlify, Fern, and more. - **Hosted CMSs**: Zendesk supported today. More coming soon! -**Enhanced Context (optional)**: Connect **Linear**, **Jira**, or **Slack** to provide Promptless with additional context for better suggestions. +**Enhanced Context (optional)**: Connect **Linear**, **Jira**, **Confluence**, or **Slack** to provide Promptless with additional context for better suggestions. Integrations Page @@ -57,7 +57,7 @@ Need both trigger types? Create separate projects with identical settings for ea ### Project Configuration Options - Select which Linear teams, Jira projects, or other sources to search for context + Select which Linear teams, Jira projects, Confluence spaces, or other sources to search for context diff --git a/fern/docs/integrations/jira.mdx b/fern/docs/integrations/atlassian.mdx similarity index 62% rename from fern/docs/integrations/jira.mdx rename to fern/docs/integrations/atlassian.mdx index 5cc34c1..ac12a20 100644 --- a/fern/docs/integrations/jira.mdx +++ b/fern/docs/integrations/atlassian.mdx @@ -1,11 +1,15 @@ -# Jira Integration +# Atlassian Integration (Jira + Confluence) **Used for: Context** -If you have Jira integration set up, when engineers reference Jira issue keys in GitHub PRs or commit messages (like "PROJ-123"), Promptless can automatically retrieve important context from the tickets to make its suggestions more accurate. +Promptless integrates with both Jira and Confluence through a single OAuth connection. When engineers reference Jira issue keys in GitHub PRs or commit messages (like "PROJ-123"), Promptless automatically retrieves the ticket for context. Promptless also searches your Confluence spaces for existing patterns, terminology, and architectural decisions to keep new documentation consistent. + +If you previously connected Jira to Promptless, reconnect to access Confluence spaces. Your existing Jira project configuration will be preserved. + + Promptless integrates with both Jira Cloud and Jira Data Center instances. ## Integration Types @@ -58,13 +62,20 @@ After connecting, manage Promptless access by going to your avatar > Account set Atlassian Connected Apps Management -## What You Can Do with Jira +## What You Can Do with Atlassian + +Once connected, you can use Jira and Confluence as context sources to enhance documentation suggestions: + +- **Jira**: Automatically retrieve ticket information and search for related issues using JQL queries. See the [Jira Context Source](/docs/configuration/context-sources/jira) page for details. +- **Confluence**: Search your Confluence spaces for existing documentation patterns, terminology, and architectural decisions. See the [Confluence Context Source](/docs/configuration/context-sources/confluence) page for details. -Once connected, you can use Jira as a [context source](/docs/configuration/context-sources/jira) to automatically retrieve ticket information and search for related issues using JQL queries. + + Atlassian integration showing both Jira projects and Confluence spaces in a unified interface + -## Provisioning a Jira Account for Promptless +## Provisioning an Atlassian Account for Promptless -We recommend creating a dedicated Jira account for Promptless so that Promptless can create Jira issues and you can track its work in your project management system. A dedicated account also gives you complete audit trail visibility and lets you configure fine-grained project permissions. +We recommend creating a dedicated Atlassian account for Promptless to access both Jira and Confluence. A dedicated account gives you complete audit trail visibility and lets you configure fine-grained permissions for both services. Create the account using an email alias like `your_email+promptless@company.com`, or ask your IT admin to provision a new email account like `promptless@company.com`. @@ -113,20 +124,20 @@ For information about how Promptless processes Jira data, including redaction ca ## Troubleshooting - - Promptless inherits the permissions of the Jira account used during OAuth connection. There are several ways to manage access depending on your security requirements: + + Promptless inherits the permissions of the Atlassian account used during OAuth connection. There are several ways to manage access depending on your security requirements: - **Standard approach:** After connecting Jira, configure which projects Promptless should search in your [project settings](https://app.gopromptless.ai/projects). Promptless won't access projects you don't explicitly configure, even if the connected account has permission to see them. + **Standard approach:** After connecting Atlassian, configure which Jira projects and Confluence spaces Promptless should search in your [project settings](https://app.gopromptless.ai/projects). Promptless won't access projects or spaces you don't explicitly configure, even if the connected account has permission to see them. - **For highly confidential projects:** Create a Jira user account that only has access to non-confidential projects, then connect Jira to Promptless using this limited-access account. This restricts access at the Jira permissions level, adding an extra security layer. + **For highly confidential content:** Create an Atlassian user account that only has access to non-confidential projects and spaces, then connect Atlassian to Promptless using this limited-access account. This restricts access at the Atlassian permissions level, adding an extra security layer. - **For granular control:** [Provision a dedicated Jira account for Promptless](#provisioning-a-jira-account-for-promptless) and configure fine-grained project permissions for this account in Jira's user management before connecting it to Promptless. + **For granular control:** [Provision a dedicated Atlassian account for Promptless](#provisioning-an-atlassian-account-for-promptless) and configure fine-grained permissions for both Jira projects and Confluence spaces in Atlassian's user management before connecting it to Promptless. - - Disconnect Jira from the [integrations page](https://app.gopromptless.ai/integrations) - - Sign out of your personal Jira account in your browser + - Disconnect Atlassian from the [integrations page](https://app.gopromptless.ai/integrations) + - Sign out of your personal Atlassian account in your browser - Sign in to the Promptless bot account you created - - Reconnect Jira to Promptless while signed in to the bot account + - Reconnect Atlassian to Promptless while signed in to the bot account diff --git a/fern/docs/integrations/index.mdx b/fern/docs/integrations/index.mdx index 6ae0414..2570772 100644 --- a/fern/docs/integrations/index.mdx +++ b/fern/docs/integrations/index.mdx @@ -14,7 +14,7 @@ Some integrations can be used for multiple purposes. Some integrations are in a - [Bitbucket](/docs/integrations/bitbucket-integration): Trigger based on Pull Requests and publish documentation to Bitbucket repos - [GitHub](/docs/integrations/github-integration): Trigger based on Pull Requests, research based on code functionality, and publish documentation to GitHub repos - [GitHub Enterprise](/docs/integrations/github-enterprise-integration): Custom GitHub App configuration for GitHub Enterprise Server and Enterprise Cloud users -- [Jira](/docs/integrations/jira-integration): Look up relevant Jira issues and project data using JQL search capabilities when being triggered +- [Atlassian](/docs/integrations/atlassian-integration): Look up relevant Jira issues and Confluence spaces for context when creating documentation - [Linear](/docs/integrations/linear-integration): Look up relevant Linear issues and projects within a team when being triggered - [Microsoft Teams](/docs/integrations/microsoft-teams-integration): Trigger based on mentions and message actions in Microsoft Teams - [Slack](/docs/integrations/slack-integration): Trigger based on DMs or message actions in Slack