[TRI-1394] Improve the Linear integration documentation

[D-K-P]

Overview:

Update the Linear integration documentation so it is much easier to use as a reference.

We have just overhauled our GitHub documentation and would like all of the rest of our integrations to follow the same structure.

Please use the references and resources at the bottom of this post to complete this issue.

Pages to add:

Linear overview & authentication:

This page is currently this.

• Page Title: Linear overview & authentication
• Sidebar title: Overview & authentication
• Page content: authentication with Linear, in the same format as this: https://trigger.dev/docs/integrations/apis/github

Linear Triggers & events:

• Page title: Linear triggers & events
• Sidebar title: Triggers & events
• Page content: all the triggers and events available from our Linear integration, in the same format as this: https://trigger.dev/docs/integrations/apis/github-triggers

Linear Tasks:

• Page title: Linear tasks
• Sidebar title: Tasks
• Page content: all the tasks available from our Linear integration, in the same format as this: https://trigger.dev/docs/integrations/apis/github-tasks. Also include one example at the bottom with clear comments. See references below for sample code.

References & resources:

• Our current Linear documentation in the GitHub repo.
• Example job code to use - job catalog and jobs showcase.
• We use Mintlify for our docs, documentation here

_TRI-1394

[Rutam21]

@D-K-P I would like to work on this. Please assign it to me. Thanks.

[D-K-P]

Hey @Rutam21 - we’re not assigning issues, we’ll accept the best PR for an issue (not necessarily the first PR either). Triaging assignments during hacktoberfest doesn’t scale.

[D-K-P]

@nujovich thank you, this is getting there. For Triggers & events and Tasks they need to be formatted in the same way that GitHub is: https://trigger.dev/docs/integrations/apis/github-triggers and https://trigger.dev/docs/integrations/apis/github-tasks

Every trigger, event and task needs to have a code example as well a link to the official Linear API documentation. You can check the GItHub integration docs pages for the correct format.

[nujovich]

@nujovich thank you, this is getting there. For Triggers & events and Tasks they need to be formatted in the same way that GitHub is: https://trigger.dev/docs/integrations/apis/github-triggers and https://trigger.dev/docs/integrations/apis/github-tasks

Every trigger, event and task needs to have a code example as well a link to the official Linear API documentation. You can check the GItHub integration docs pages for the correct format.

Great ! I will work on the changes through the day

[D-K-P]

@nujovich how's it going?

[nujovich]

@nujovich how's it going?

I found it hard to complete the task documentation as there's no official link to examples :(. But I manged it. Today I will finish events & triggers :)

[D-K-P]

Awesome, thanks. I'm also going to raise the points to 500 for this one because it is a much larger change than some of the other docs changes. Thanks @nujovich, looking forward to seeing the PR come through!

[D-K-P]

Hey @nujovich, sorry about the delay on this.

• If you can't find the official API documentation for a Trigger or a Task then you don't need to provide a link, because lots of them are currently linking to the wrong place. I didn't realise how little documentation Linear had so it's ok in this case.
• Could you add an example to the bottom of the Tasks page please. This should show how to use the underlying client like the GitHub integration example

Thank you!

[D-K-P]

hey @nujovich, it's the last evening for Hacktoberfest - how are you getting on?

[nujovich]

hey @nujovich, it's the last evening for Hacktoberfest - how are you getting on?

Hi @D-K-P ! I missed the deadline. A lot going on at work. I would like to end this contribution and keep contributing, as we are having an opensource jam here in Alicante, Spain in the upcoming weeks