Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions integrations/linear.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: 'Linear integration'

To easily keep track of feature requests and bugs reported in Plain, you can connect your Linear workspace with Plain.

This lets you easily link a Linear issue to a thread – and ensures you're always prompted to reply to a customer when their bug is fixed or feature request is shipped.
This lets you easily link a Linear issue to a thread – and ensures you're always reminded to reply to a customer when their bug is fixed or feature request is shipped. Threads are automatically moved to "Close the Loop" status when the associated Linear issue is complete. 

To do this, head to **Settings** → **Linear integration** and connect your workspace.

Expand All @@ -16,11 +16,16 @@ Once a Linear issue is linked, the thread will move back to `Close the loop` whe

Once you connect your Linear account and start linking issues to customer requests, you'll get access to a new Product insights page in Plain – where you'll be able to get a ranked view of your top customer requests from Linear directly in Plain. You can also dig into each request, to understand which customers requested each feature, the tier breakdown of these customers and when the request was initially made.

### Linear Templates

If you've created templates for issues in Linear, you can choose which template you want to use every time you create a new issue from Plain. Get consistent with how you manage bugs, feature requests, or engineering tickets and ensure they're always presented the same way. 

When creating a Linear issue, just hit "No template" and choose the template you want to use. 

### Customer Requests

If your Linear workspace supports Customer Requests, we'll create a Customer and a Customer Request when linking a Plain thread to a Linear issue.

Linear Customers are created by looking at the Customer's company domain on the thread. If a Plain thread has no company domain, we won't create a Linear Customer or Customer Request.

If Linear Customer requests is disabled in your workspace, our linear integration will still create Customers and Customer Requests in the background, so if you decide to enable it, they'll be ready to go.

If Linear Customer requests is disabled in your workspace, our linear integration will still create Customers and Customer Requests in the background, so if you decide to enable it, they'll be ready to go.
25 changes: 15 additions & 10 deletions plain-ai/knowledge-sources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
title: 'Knowledge Sources'
---

Documentation can be indexed by using the [Plain CLI](https://github.com/team-plain/cli). With it you can index:
Documentation can be indexed in two ways: either by adding URLs by navigating to your workspace settings and selecting "Knowledge Sources", or by using the [Plain CLI](https://github.com/team-plain/cli). With it you can index:

- a single URL
- a sitemap URL (each entry in the sitemap is indexed)
- Optional: add a [label type ID](/labels) to associate the document with
* a single URL

For installation and usage instructions, please see the [Plain CLI docs](https://github.com/team-plain/cli).
* a sitemap URL (each entry in the sitemap is indexed)

* Optional: add a [label type ID](/labels) to associate the document with

For installation and usage instructions, please see the [Plain CLI docs](https://github.com/team-plain/cli). Note: to add multiple URLs via a sitemap, you'll need to use the Plain CLI `index-sitemap` command. For individual URLs, you can use the Knowledge Sources settings page, or the `index-url` CL command.

### Labels

Expand All @@ -24,12 +26,15 @@ To keep indexed documents up to date, you can automate the indexing process the

Here is an example Github Action to re-index the documents using the [Plain CLI](https://github.com/team-plain/cli) run on a schedule.

- The action runs every 3 hours
- The action uses the `PLAIN_API_KEY` secret to authenticate with the Plain API
- The action indexes all URLs in the sitemap
* The action runs every 3 hours

* The action uses the `PLAIN_API_KEY` secret to authenticate with the Plain API

* The action indexes all URLs in the sitemap

The `PLAIN_API_KEY` requires the following permissions:
- `indexedDocument:create`

* `indexedDocument:create`

```yaml
name: Index docs
Expand All @@ -55,4 +60,4 @@ jobs:
run: plain index-sitemap https://www.plain.com/docs/sitemap.xml --labelTypeIds lt_01G0EZ1XTM37C643SQTDNXR1
env:
PLAIN_API_KEY: ${{ secrets.PLAIN_API_KEY }}
```
```
Loading