-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathconfig.mts
More file actions
970 lines (940 loc) · 49.2 KB
/
config.mts
File metadata and controls
970 lines (940 loc) · 49.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
import { defineConfig, type HeadConfig } from "vitepress";
import { tabsMarkdownPlugin } from "vitepress-plugin-tabs";
import { withMermaid } from "vitepress-plugin-mermaid";
import { readFileSync } from "node:fs";
import { resolve } from "node:path";
function loadEnvVar(key: string): string | undefined {
// process.env takes precedence (CI/hosting platforms set vars here)
if (key in process.env) return process.env[key] || undefined;
// Fall back to .env file for local development
try {
const envFile = readFileSync(resolve(process.cwd(), ".env"), "utf-8");
const match = envFile.match(new RegExp(`^${key}=(.+)$`, "m"));
return match?.[1]?.trim();
} catch {
return undefined;
}
}
const posthogKey = loadEnvVar("VITE_POSTHOG_KEY");
const algoliaAppId = loadEnvVar("VITE_ALGOLIA_APP_ID");
const algoliaApiKey = loadEnvVar("VITE_ALGOLIA_API_KEY");
const algoliaIndexName = loadEnvVar("VITE_ALGOLIA_INDEX_NAME");
const searchConfig =
algoliaAppId && algoliaApiKey && algoliaIndexName
? {
provider: "algolia" as const,
options: {
appId: algoliaAppId,
apiKey: algoliaApiKey,
indexName: algoliaIndexName,
insights: true,
},
}
: { provider: "local" as const };
const posthogHead: HeadConfig[] = posthogKey
? [
[
"script",
{},
`
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="init capture register register_once register_for_session unregister unregister_for_session getFeatureFlag getFeatureFlagPayload isFeatureEnabled reloadFeatureFlags updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures on onFeatureFlags onSessionId getSurveys getActiveMatchingSurveys renderSurvey canRenderSurvey getNextSurveyStep identify setPersonProperties group resetGroups setPersonPropertiesForFlags resetPersonPropertiesForFlags setGroupPropertiesForFlags resetGroupPropertiesForFlags reset get_distinct_id getGroups get_session_id get_session_replay_url alias set_config startSessionRecording stopSessionRecording sessionRecordingStarted captureException loadToolbar get_property getSessionProperty createPersonProfile opt_in_capturing opt_out_capturing has_opted_in_capturing has_opted_out_capturing clear_opt_in_out_capturing debug getPageViewId captureTraceFeedback captureTraceMetric".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
posthog.init('${posthogKey}',{api_host:'https://us.posthog.com', opt_out_capturing_by_default: true, persistence: 'memory'});
`,
],
]
: [];
export default withMermaid(
defineConfig({
markdown: {
config(md) {
md.use(tabsMarkdownPlugin);
},
},
mermaid: {
// Mermaid configuration options
},
vite: {
optimizeDeps: {
include: [
"lucide-vue-next",
"mermaid",
"@braintree/sanitize-url",
"dayjs",
"cytoscape",
"cytoscape-cose-bilkent",
"d3",
"khroma",
"dagre-d3-es",
"lodash-es",
"dompurify",
],
},
},
title: "Plane developer documentation",
description:
"Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform. Complete guides for developers building on Plane.",
// SEO: Generate sitemap automatically
sitemap: {
hostname: "https://developers.plane.so",
},
// SEO: Clean URLs without .html extension
cleanUrls: true,
// SEO: Title template for all pages
titleTemplate: ":title | Plane",
head: [
["link", { rel: "icon", href: "/logo/favicon-32x32.png" }],
[
"link",
{
rel: "preload",
href: "/fonts/Inter/InterVariable.woff2",
as: "font",
type: "font/woff2",
crossorigin: "",
},
],
// Google Analytics with Consent Mode v2
["script", { async: "", src: "https://www.googletagmanager.com/gtag/js?id=G-JF828SKW90" }],
[
"script",
{},
`window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('consent', 'default', {
'analytics_storage': 'denied',
'ad_storage': 'denied',
'ad_user_data': 'denied',
'ad_personalization': 'denied'
});
gtag('js', new Date());
gtag('config', 'G-JF828SKW90');`,
],
// PostHog Analytics (loaded only when VITE_POSTHOG_KEY is set)
...posthogHead,
// SEO: Basic meta tags
["meta", { name: "viewport", content: "width=device-width, initial-scale=1.0" }],
["meta", { name: "author", content: "Plane" }],
["meta", { name: "robots", content: "index, follow" }],
[
"meta",
{
name: "keywords",
content:
"plane, api, self-hosting, project management, developer documentation, kubernetes, docker, rest api, webhooks, plane api",
},
],
["meta", { name: "theme-color", content: "#3b82f6" }],
// Open Graph meta tags
["meta", { property: "og:type", content: "website" }],
["meta", { property: "og:title", content: "Developer documentation | Plane" }],
[
"meta",
{
property: "og:description",
content:
"Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform.",
},
],
["meta", { property: "og:image", content: "https://media.docs.plane.so/logo/og-docs.webp#hero" }],
["meta", { property: "og:url", content: "https://developers.plane.so" }],
// Twitter Card meta tags
["meta", { name: "twitter:card", content: "summary_large_image" }],
["meta", { name: "twitter:title", content: "Developer documentation | Plane" }],
[
"meta",
{
name: "twitter:description",
content:
"Self-host Plane, integrate with our API, configure webhooks, and extend your project management platform.",
},
],
["meta", { name: "twitter:image", content: "https://media.docs.plane.so/logo/og-docs.webp#hero" }],
],
transformPageData(pageData) {
const head = (pageData.frontmatter.head ??= []);
// Inject canonical URL if not already defined in frontmatter
const hasCanonical = head.some(([tag, attrs]) => tag === "link" && attrs?.rel === "canonical");
if (!hasCanonical) {
const canonicalUrl = `https://developers.plane.so/${pageData.relativePath}`
.replace(/index\.md$/, "")
.replace(/\.md$/, "");
head.push(["link", { rel: "canonical", href: canonicalUrl }]);
}
// Inject frontmatter keywords as a meta tag (VitePress doesn't do this natively)
const keywords = pageData.frontmatter.keywords;
if (keywords) {
head.push(["meta", { name: "keywords", content: keywords }]);
}
},
themeConfig: {
siteTitle: false,
logo: {
light: "/logo/dev-logo-watermark-light.png",
dark: "/logo/dev-logo-watermark-dark.png",
},
outline: {
level: [2, 3],
label: "On this page",
},
nav: [
{ text: "Self-hosting", link: "/self-hosting/overview" },
{ text: "API Reference", link: "/api-reference/introduction" },
{ text: "Build and extend", link: "/dev-tools/build-plane-app/overview" },
{ text: "Plane Docs", link: "https://docs.plane.so" },
{ text: "Sign in", link: "https://app.plane.so/sign-in" },
],
sidebar: {
"/self-hosting/": [
{
text: "Self-host Plane",
items: [
{ text: "Overview", link: "/self-hosting/overview" },
{ text: "Plane Editions", link: "/self-hosting/editions-and-versions" },
{ text: "Plane Architecture", link: "/self-hosting/plane-architecture" },
],
},
{
text: "Install",
items: [
{ text: "Overview", link: "/self-hosting/methods/overview" },
{
text: "Docker",
collapsed: true,
items: [
{ text: "Docker Compose", link: "/self-hosting/methods/docker-compose" },
{ text: "Docker AIO", link: "/self-hosting/methods/docker-aio" },
{ text: "Docker Swarm", link: "/self-hosting/methods/docker-swarm" },
{ text: "Download config files", link: "/self-hosting/methods/download-config" },
],
},
{ text: "Kubernetes", link: "/self-hosting/methods/kubernetes" },
{ text: "Podman Quadlets", link: "/self-hosting/methods/podman-quadlets" },
{
text: "Airgapped Edition",
collapsed: true,
items: [
{ text: "Overview", link: "/self-hosting/methods/airgapped-requirements" },
{ text: "On Docker", link: "/self-hosting/methods/airgapped-edition" },
{ text: "On Kubernetes", link: "/self-hosting/methods/airgapped-edition-kubernetes" },
{ text: "Clone Docker Images", link: "/self-hosting/methods/clone-docker-images" },
],
},
{
text: "Managed Platforms",
collapsed: true,
items: [
{ text: "Coolify", link: "/self-hosting/methods/coolify" },
{ text: "Portainer", link: "/self-hosting/methods/portainer" },
],
},
],
},
{
text: "Configure",
items: [
{ text: "Instance Admin", link: "/self-hosting/govern/instance-admin" },
{
text: "Authentication",
collapsed: true,
items: [
{ text: "Overview", link: "/self-hosting/govern/authentication" },
{ text: "Google OAuth", link: "/self-hosting/govern/google-oauth" },
{ text: "GitHub OAuth", link: "/self-hosting/govern/github-oauth" },
{ text: "OIDC SSO", link: "/self-hosting/govern/oidc-sso" },
{ text: "SAML SSO", link: "/self-hosting/govern/saml-sso" },
{ text: "LDAP", link: "/self-hosting/govern/ldap" },
{ text: "Reset Password", link: "/self-hosting/govern/reset-password" },
],
},
{ text: "SMTP for email", link: "/self-hosting/govern/communication" },
{ text: "External services", link: "/self-hosting/govern/database-and-storage" },
{ text: "Custom domain", link: "/self-hosting/govern/custom-domain" },
{ text: "SSL", link: "/self-hosting/govern/configure-ssl" },
{
text: "Integrations",
collapsed: true,
items: [
{ text: "GitHub", link: "/self-hosting/govern/integrations/github" },
{ text: "GitLab", link: "/self-hosting/govern/integrations/gitlab" },
{ text: "Sentry", link: "/self-hosting/govern/integrations/sentry" },
{ text: "Slack", link: "/self-hosting/govern/integrations/slack" },
],
},
{ text: "DNS for Intake Email", link: "/self-hosting/govern/configure-dns-email-service" },
{ text: "OpenSearch for search", link: "/self-hosting/govern/advanced-search" },
{
text: "Plane AI",
link: "/self-hosting/govern/plane-ai",
collapsed: true,
items: [{ text: "AWS OpenSearch embedding", link: "/self-hosting/govern/aws-opensearch-embedding" }],
},
{ text: "External secrets", link: "/self-hosting/govern/external-secrets" },
{ text: "External reverse proxy", link: "/self-hosting/govern/reverse-proxy" },
{ text: "Private storage buckets", link: "/self-hosting/govern/private-bucket" },
{ text: "Environment variables", link: "/self-hosting/govern/environment-variables" },
{ text: "Telemetry", link: "/self-hosting/telemetry" },
],
},
{
text: "Manage",
items: [
{
text: "Update Plane",
collapsed: true,
items: [
{ text: "Update to latest version", link: "/self-hosting/manage/upgrade-plane" },
{ text: "For versions before 0.14.0", link: "/self-hosting/manage/upgrade-from-0.13.2-0.14.0" },
{
text: "Airgapped Edition",
collapsed: true,
items: [
{
text: "On Docker",
link: "/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker",
},
{
text: "On Kubernetes",
link: "/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes",
},
],
},
],
},
{
text: "Manage licenses",
collapsed: true,
items: [
{
text: "Commercial Edition",
collapsed: true,
items: [
{
text: "Pro or Business",
link: "/self-hosting/manage/manage-licenses/activate-pro-and-business",
},
{ text: "Enterprise Grid", link: "/self-hosting/manage/manage-licenses/activate-enterprise" },
],
},
{
text: "Airgapped Edition",
collapsed: true,
items: [
{ text: "Pro or Business", link: "/self-hosting/manage/manage-licenses/activate-airgapped" },
{
text: "Enterprise Grid",
link: "/self-hosting/manage/manage-licenses/activate-airgapped-enterprise",
},
],
},
],
},
{ text: "Backup and restore", link: "/self-hosting/manage/backup-restore" },
{ text: "Upgrade Community to Commercial Edition", link: "/self-hosting/upgrade-from-community" },
{ text: "Upgrade Community to Airgapped Edition", link: "/self-hosting/manage/community-to-airgapped" },
{ text: "View Logs", link: "/self-hosting/manage/view-logs" },
{ text: "Migrate Plane", link: "/self-hosting/manage/migrate-plane" },
{ text: "Prime CLI", link: "/self-hosting/manage/prime-cli" },
{ text: "Manage users", link: "/self-hosting/manage/manage-instance-users" },
],
},
{
text: "Troubleshoot",
items: [
{ text: "Overview", link: "/self-hosting/troubleshoot/overview" },
{ text: "Installation Errors", link: "/self-hosting/troubleshoot/installation-errors" },
{ text: "License Errors", link: "/self-hosting/troubleshoot/license-errors" },
{ text: "CLI Errors", link: "/self-hosting/troubleshoot/cli-errors" },
{ text: "Storage Errors", link: "/self-hosting/troubleshoot/storage-errors" },
],
},
],
"/api-reference/": [
{
text: "API Reference",
items: [
{ text: "Introduction", link: "/api-reference/introduction" },
{
text: "Project",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/project/overview" },
{ text: "Create Project", link: "/api-reference/project/add-project" },
{ text: "List Projects", link: "/api-reference/project/list-projects" },
{ text: "Get Project", link: "/api-reference/project/get-project-detail" },
{ text: "Update Project", link: "/api-reference/project/update-project-detail" },
{ text: "Archive Project", link: "/api-reference/project/archive-project" },
{ text: "Unarchive Project", link: "/api-reference/project/unarchive-project" },
{ text: "Delete Project", link: "/api-reference/project/delete-project" },
],
},
{
text: "Project Features",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/project-features/overview" },
{ text: "Get Project Features", link: "/api-reference/project-features/get-project-features" },
{
text: "Update Project Features",
link: "/api-reference/project-features/update-project-features",
},
],
},
{
text: "Project Labels",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/project-labels/overview" },
{ text: "Create Project Label", link: "/api-reference/project-labels/add-project-label" },
{ text: "List Project Labels", link: "/api-reference/project-labels/list-project-labels" },
{
text: "Get Project Label",
link: "/api-reference/project-labels/get-project-label-detail",
},
{
text: "Update Project Label",
link: "/api-reference/project-labels/update-project-label-detail",
},
{ text: "Delete Project Label", link: "/api-reference/project-labels/delete-project-label" },
],
},
{
text: "Work Item",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue/overview" },
{ text: "Create Work Item", link: "/api-reference/issue/add-issue" },
{ text: "List Work Items", link: "/api-reference/issue/list-issues" },
{ text: "Get Work Item", link: "/api-reference/issue/get-issue-detail" },
{ text: "Get by identifier", link: "/api-reference/issue/get-issue-sequence-id" },
{ text: "Search Work Items", link: "/api-reference/issue/search-issues" },
{ text: "Advanced Search", link: "/api-reference/issue/advanced-search-work-items" },
{ text: "Update Work Item", link: "/api-reference/issue/update-issue-detail" },
{ text: "Delete Work Item", link: "/api-reference/issue/delete-issue" },
],
},
{
text: "Work Item States",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/state/overview" },
{ text: "Create State", link: "/api-reference/state/add-state" },
{ text: "List States", link: "/api-reference/state/list-states" },
{ text: "Get State", link: "/api-reference/state/get-state-detail" },
{ text: "Update State", link: "/api-reference/state/update-state-detail" },
{ text: "Delete State", link: "/api-reference/state/delete-state" },
],
},
{
text: "Work Item Labels",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/label/overview" },
{ text: "Create Label", link: "/api-reference/label/add-label" },
{ text: "List Labels", link: "/api-reference/label/list-labels" },
{ text: "Get Label", link: "/api-reference/label/get-label-detail" },
{ text: "Update Label", link: "/api-reference/label/update-label-detail" },
{ text: "Delete Label", link: "/api-reference/label/delete-label" },
],
},
{
text: "Work Item Types",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue-types/types/overview" },
{ text: "Add Type", link: "/api-reference/issue-types/types/add-issue-type" },
{ text: "List Types", link: "/api-reference/issue-types/types/list-issue-types" },
{ text: "Get Type Details", link: "/api-reference/issue-types/types/get-issue-type-details" },
{ text: "Get Type Schema", link: "/api-reference/issue-types/types/get-work-item-type-schema" },
{ text: "Update Type", link: "/api-reference/issue-types/types/update-issue-types" },
{ text: "Delete Type", link: "/api-reference/issue-types/types/delete-issue-type" },
],
},
{
text: "Custom Properties",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue-types/properties/overview" },
{ text: "Add Property", link: "/api-reference/issue-types/properties/add-property" },
{ text: "List Properties", link: "/api-reference/issue-types/properties/list-properties" },
{ text: "Get Property Details", link: "/api-reference/issue-types/properties/get-property-details" },
{ text: "Update Property", link: "/api-reference/issue-types/properties/update-property" },
{ text: "Delete Property", link: "/api-reference/issue-types/properties/delete-property" },
],
},
{
text: "Custom Property Values",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue-types/values/overview" },
{ text: "Add Property Values", link: "/api-reference/issue-types/values/add-property-values" },
{ text: "List Property Values", link: "/api-reference/issue-types/values/list-property-values" },
{ text: "Get Property Value", link: "/api-reference/issue-types/values/get-property-value-detail" },
{ text: "Update Property Value", link: "/api-reference/issue-types/values/update-property-value" },
{ text: "Delete Property Value", link: "/api-reference/issue-types/values/delete-property-value" },
],
},
{
text: "Custom Property Options",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue-types/options/overview" },
{ text: "Add Dropdown Options", link: "/api-reference/issue-types/options/add-dropdown-options" },
{ text: "List Dropdown Options", link: "/api-reference/issue-types/options/list-dropdown-options" },
{ text: "Get Option Details", link: "/api-reference/issue-types/options/get-option-details" },
{
text: "Update Dropdown Options",
link: "/api-reference/issue-types/options/update-dropdown-options",
},
{
text: "Delete Dropdown Options",
link: "/api-reference/issue-types/options/delete-dropdown-options",
},
],
},
{
text: "Work Item Links",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/link/overview" },
{ text: "Add Link", link: "/api-reference/link/add-link" },
{ text: "List Links", link: "/api-reference/link/list-links" },
{ text: "Get Link", link: "/api-reference/link/get-link-detail" },
{ text: "Update Link", link: "/api-reference/link/update-link-detail" },
{ text: "Delete Link", link: "/api-reference/link/delete-link" },
],
},
{
text: "Work Item Activity",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue-activity/overview" },
{ text: "List Activities", link: "/api-reference/issue-activity/list-issue-activities" },
{ text: "Get Activity", link: "/api-reference/issue-activity/get-issue-activity-detail" },
],
},
{
text: "Work Item Comments",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue-comment/overview" },
{ text: "Add Comment", link: "/api-reference/issue-comment/add-issue-comment" },
{ text: "List Comments", link: "/api-reference/issue-comment/list-issue-comments" },
{ text: "Get Comment", link: "/api-reference/issue-comment/get-issue-comment-detail" },
{ text: "Update Comment", link: "/api-reference/issue-comment/update-issue-comment-detail" },
{ text: "Delete Comment", link: "/api-reference/issue-comment/delete-issue-comment" },
],
},
{
text: "Work Item Attachments",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/issue-attachments/overview" },
{ text: "Get Attachments", link: "/api-reference/issue-attachments/get-attachments" },
{ text: "Get Attachment Detail", link: "/api-reference/issue-attachments/get-attachment-detail" },
{ text: "Get Upload Credentials", link: "/api-reference/issue-attachments/get-upload-credentials" },
{ text: "Upload File", link: "/api-reference/issue-attachments/upload-file" },
{ text: "Complete Upload", link: "/api-reference/issue-attachments/complete-upload" },
{ text: "Update Attachment", link: "/api-reference/issue-attachments/update-attachment" },
{ text: "Delete Attachment", link: "/api-reference/issue-attachments/delete-attachment" },
],
},
{
text: "Work Item Page Links",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/work-item-pages/overview" },
{ text: "Create Work Item Page Link", link: "/api-reference/work-item-pages/add-work-item-page" },
{ text: "List Work Item Pages", link: "/api-reference/work-item-pages/list-work-item-pages" },
{
text: "Get Work Item Page Link",
link: "/api-reference/work-item-pages/get-work-item-page-detail",
},
{
text: "Delete Work Item Page Link",
link: "/api-reference/work-item-pages/delete-work-item-page",
},
],
},
{
text: "Cycles",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/cycle/overview" },
{ text: "Create Cycle", link: "/api-reference/cycle/add-cycle" },
{ text: "Add Work Items", link: "/api-reference/cycle/add-cycle-work-items" },
{ text: "Transfer Work Items", link: "/api-reference/cycle/transfer-cycle-work-items" },
{ text: "Archive Cycle", link: "/api-reference/cycle/archive-cycle" },
{ text: "List Cycles", link: "/api-reference/cycle/list-cycles" },
{ text: "Get Cycle", link: "/api-reference/cycle/get-cycle-detail" },
{ text: "List Cycle Work Items", link: "/api-reference/cycle/list-cycle-work-items" },
{ text: "List Archived Cycles", link: "/api-reference/cycle/list-archived-cycles" },
{ text: "Update Cycle", link: "/api-reference/cycle/update-cycle-detail" },
{ text: "Unarchive Cycle", link: "/api-reference/cycle/unarchive-cycle" },
{ text: "Remove Work Item", link: "/api-reference/cycle/remove-cycle-work-item" },
{ text: "Delete Cycle", link: "/api-reference/cycle/delete-cycle" },
],
},
{
text: "Modules",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/module/overview" },
{ text: "Create Module", link: "/api-reference/module/add-module" },
{ text: "Add Work Items", link: "/api-reference/module/add-module-work-items" },
{ text: "Archive Module", link: "/api-reference/module/archive-module" },
{ text: "List Modules", link: "/api-reference/module/list-modules" },
{ text: "Get Module", link: "/api-reference/module/get-module-detail" },
{ text: "List Module Work Items", link: "/api-reference/module/list-module-work-items" },
{ text: "List Archived Modules", link: "/api-reference/module/list-archived-modules" },
{ text: "Update Module", link: "/api-reference/module/update-module-detail" },
{ text: "Unarchive Module", link: "/api-reference/module/unarchive-module" },
{ text: "Remove Work Item", link: "/api-reference/module/remove-module-work-item" },
{ text: "Delete Module", link: "/api-reference/module/delete-module" },
],
},
{
text: "Pages",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/page/overview" },
{ text: "Add Workspace Page", link: "/api-reference/page/add-workspace-page" },
{ text: "Add Project Page", link: "/api-reference/page/add-project-page" },
{ text: "Get Workspace Page", link: "/api-reference/page/get-workspace-page" },
{ text: "Get Project Page", link: "/api-reference/page/get-project-page" },
],
},
{
text: "Intake",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/intake-issue/overview" },
{ text: "Add Intake Issue", link: "/api-reference/intake-issue/add-intake-issue" },
{ text: "List Intake Issues", link: "/api-reference/intake-issue/list-intake-issues" },
{ text: "Get Intake Issue", link: "/api-reference/intake-issue/get-intake-issue-detail" },
{ text: "Update Intake Issue", link: "/api-reference/intake-issue/update-intake-issue-detail" },
{ text: "Delete Intake Issue", link: "/api-reference/intake-issue/delete-intake-issue" },
],
},
{
text: "Assets",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/assets/overview" },
{ text: "Create User Asset Upload", link: "/api-reference/assets/create-user-asset-upload" },
{ text: "Update User Asset", link: "/api-reference/assets/update-user-asset" },
{ text: "Delete User Asset", link: "/api-reference/assets/delete-user-asset" },
{
text: "Create Workspace Asset Upload",
link: "/api-reference/assets/create-workspace-asset-upload",
},
{ text: "Get Workspace Asset", link: "/api-reference/assets/get-workspace-asset" },
{ text: "Update Workspace Asset", link: "/api-reference/assets/update-workspace-asset" },
],
},
{
text: "Milestones",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/milestones/overview" },
{ text: "Create Milestone", link: "/api-reference/milestones/add-milestone" },
{ text: "List Milestones", link: "/api-reference/milestones/list-milestones" },
{ text: "Get Milestone", link: "/api-reference/milestones/get-milestone-detail" },
{ text: "List Milestone Work Items", link: "/api-reference/milestones/list-milestone-work-items" },
{ text: "Update Milestone", link: "/api-reference/milestones/update-milestone-detail" },
{ text: "Delete Milestone", link: "/api-reference/milestones/delete-milestone" },
],
},
{
text: "Estimates",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/estimate/overview" },
{ text: "Create Estimate", link: "/api-reference/estimate/add-estimate" },
{ text: "Get Estimate", link: "/api-reference/estimate/get-estimate" },
{ text: "Update Estimate", link: "/api-reference/estimate/update-estimate" },
{ text: "Delete Estimate", link: "/api-reference/estimate/delete-estimate" },
{ text: "List Estimate Points", link: "/api-reference/estimate/list-estimate-points" },
{ text: "Create Estimate Points", link: "/api-reference/estimate/add-estimate-points" },
{ text: "Update Estimate Point", link: "/api-reference/estimate/update-estimate-point" },
{ text: "Delete Estimate Point", link: "/api-reference/estimate/delete-estimate-point" },
],
},
{
text: "Time Tracking",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/worklogs/overview" },
{ text: "Create Worklog", link: "/api-reference/worklogs/create-worklog" },
{ text: "Get Worklogs for Issue", link: "/api-reference/worklogs/get-worklogs-for-issue" },
{ text: "Get Total Time", link: "/api-reference/worklogs/get-total-time" },
{ text: "Update Worklog", link: "/api-reference/worklogs/update-worklog" },
{ text: "Delete Worklog", link: "/api-reference/worklogs/delete-worklog" },
],
},
{
text: "Epics",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/epics/overview" },
{ text: "Create Epic", link: "/api-reference/epics/create-epic" },
{ text: "List Epics", link: "/api-reference/epics/list-epics" },
{ text: "Get Epic", link: "/api-reference/epics/get-epic-detail" },
{ text: "Update Epic", link: "/api-reference/epics/update-epic" },
{ text: "Delete Epic", link: "/api-reference/epics/delete-epic" },
{ text: "Add Epic Work Items", link: "/api-reference/epics/add-epic-work-items" },
{ text: "List Epic Work Items", link: "/api-reference/epics/list-epic-work-items" },
],
},
{
text: "Initiatives",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/initiative/overview" },
{ text: "Create Initiative", link: "/api-reference/initiative/add-initiative" },
{ text: "List Initiatives", link: "/api-reference/initiative/list-initiatives" },
{ text: "Get Initiative", link: "/api-reference/initiative/get-initiative-detail" },
{ text: "Update Initiative", link: "/api-reference/initiative/update-initiative-detail" },
{ text: "Delete Initiative", link: "/api-reference/initiative/delete-initiative" },
],
},
{
text: "Initiative Labels",
collapsed: true,
items: [
{ text: "Add Label", link: "/api-reference/initiative/add-initiative-label" },
{ text: "Add Labels to Initiative", link: "/api-reference/initiative/add-labels-to-initiative" },
{ text: "List Initiative Labels", link: "/api-reference/initiative/list-initiative-labels" },
{ text: "Get Label Detail", link: "/api-reference/initiative/get-initiative-label-detail" },
{
text: "List Labels for Initiative",
link: "/api-reference/initiative/list-initiative-labels-for-initiative",
},
{ text: "Update Label", link: "/api-reference/initiative/update-initiative-label-detail" },
{ text: "Remove Labels", link: "/api-reference/initiative/remove-labels-from-initiative" },
{ text: "Delete Label", link: "/api-reference/initiative/delete-initiative-label" },
],
},
{
text: "Initiative Projects",
collapsed: true,
items: [
{ text: "Add Projects", link: "/api-reference/initiative/add-projects-to-initiative" },
{ text: "List Projects", link: "/api-reference/initiative/list-initiative-projects" },
{ text: "Remove Projects", link: "/api-reference/initiative/remove-projects-from-initiative" },
],
},
{
text: "Initiative Epics",
collapsed: true,
items: [
{ text: "Add Epics", link: "/api-reference/initiative/add-epics-to-initiative" },
{ text: "List Epics", link: "/api-reference/initiative/list-initiative-epics" },
{ text: "Remove Epics", link: "/api-reference/initiative/remove-epics-from-initiative" },
],
},
{
text: "Customers",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/customer/overview" },
{ text: "Add Customer", link: "/api-reference/customer/add-customer" },
{ text: "Link Work Items", link: "/api-reference/customer/link-work-items-to-customer" },
{ text: "List Customers", link: "/api-reference/customer/list-customers" },
{ text: "Get Customer", link: "/api-reference/customer/get-customer-detail" },
{ text: "List Customer Work Items", link: "/api-reference/customer/list-customer-work-items" },
{ text: "Update Customer", link: "/api-reference/customer/update-customer-detail" },
{ text: "Unlink Work Item", link: "/api-reference/customer/unlink-work-item-from-customer" },
{ text: "Delete Customer", link: "/api-reference/customer/delete-customer" },
],
},
{
text: "Customer Properties",
collapsed: true,
items: [
{ text: "Add Property", link: "/api-reference/customer/add-customer-property" },
{ text: "List Properties", link: "/api-reference/customer/list-customer-properties" },
{ text: "Get Property Detail", link: "/api-reference/customer/get-customer-property-detail" },
{ text: "List Property Values", link: "/api-reference/customer/list-customer-property-values" },
{ text: "Get Property Value", link: "/api-reference/customer/get-customer-property-value" },
{ text: "Update Property", link: "/api-reference/customer/update-customer-property-detail" },
{ text: "Update Property Value", link: "/api-reference/customer/update-customer-property-value" },
{ text: "Delete Property", link: "/api-reference/customer/delete-customer-property" },
],
},
{
text: "Customer Requests",
collapsed: true,
items: [
{ text: "Add Request", link: "/api-reference/customer/add-customer-request" },
{ text: "List Requests", link: "/api-reference/customer/list-customer-requests" },
{ text: "Get Request Detail", link: "/api-reference/customer/get-customer-request-detail" },
{ text: "Update Request", link: "/api-reference/customer/update-customer-request-detail" },
{ text: "Delete Request", link: "/api-reference/customer/delete-customer-request" },
],
},
{
text: "Teamspaces",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/teamspace/overview" },
{ text: "Create Teamspace", link: "/api-reference/teamspace/add-teamspace" },
{ text: "List Teamspaces", link: "/api-reference/teamspace/list-teamspaces" },
{ text: "Get Teamspace", link: "/api-reference/teamspace/get-teamspace-detail" },
{ text: "Update Teamspace", link: "/api-reference/teamspace/update-teamspace-detail" },
{ text: "Delete Teamspace", link: "/api-reference/teamspace/delete-teamspace" },
],
},
{
text: "Teamspace Members",
collapsed: true,
items: [
{ text: "List Members", link: "/api-reference/teamspace/list-teamspace-members" },
{ text: "Add Members", link: "/api-reference/teamspace/add-teamspace-members" },
{ text: "Remove Members", link: "/api-reference/teamspace/remove-teamspace-members" },
],
},
{
text: "Teamspace Projects",
collapsed: true,
items: [
{ text: "List Projects", link: "/api-reference/teamspace/list-teamspace-projects" },
{ text: "Add Projects", link: "/api-reference/teamspace/add-projects-to-teamspace" },
{ text: "Remove Projects", link: "/api-reference/teamspace/remove-projects-from-teamspace" },
],
},
{
text: "Stickies",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/sticky/overview" },
{ text: "Add Sticky", link: "/api-reference/sticky/add-sticky" },
{ text: "List Stickies", link: "/api-reference/sticky/list-stickies" },
{ text: "Get Sticky", link: "/api-reference/sticky/get-sticky-detail" },
{ text: "Update Sticky", link: "/api-reference/sticky/update-sticky-detail" },
{ text: "Delete Sticky", link: "/api-reference/sticky/delete-sticky" },
],
},
{
text: "Workspace Features",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/workspace-features/overview" },
{
text: "Get Workspace Features",
link: "/api-reference/workspace-features/get-workspace-features",
},
{
text: "Update Workspace Features",
link: "/api-reference/workspace-features/update-workspace-features",
},
],
},
{
text: "Workspace Invitations",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/workspace-invitations/overview" },
{
text: "Create Workspace Invitation",
link: "/api-reference/workspace-invitations/add-workspace-invitation",
},
{
text: "List Workspace Invitations",
link: "/api-reference/workspace-invitations/list-workspace-invitations",
},
{
text: "Get Workspace Invitation",
link: "/api-reference/workspace-invitations/get-workspace-invitation-detail",
},
{
text: "Update Workspace Invitation",
link: "/api-reference/workspace-invitations/update-workspace-invitation",
},
{
text: "Delete Workspace Invitation",
link: "/api-reference/workspace-invitations/delete-workspace-invitation",
},
],
},
{
text: "Members",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/members/overview" },
{ text: "Get Workspace Members", link: "/api-reference/members/get-workspace-members" },
{ text: "Get Project Members", link: "/api-reference/members/get-project-members" },
{ text: "Create Project Member", link: "/api-reference/members/add-project-member" },
{ text: "Get Project Member", link: "/api-reference/members/get-project-member-detail" },
{ text: "Update Project Member", link: "/api-reference/members/update-project-member" },
{ text: "Delete Project Member", link: "/api-reference/members/delete-project-member" },
{ text: "Remove Workspace Members", link: "/api-reference/members/remove-workspace-member" },
],
},
{
text: "User",
collapsed: true,
items: [
{ text: "Overview", link: "/api-reference/user/overview" },
{ text: "Get Current User", link: "/api-reference/user/get-current-user" },
],
},
],
},
],
"/dev-tools/": [
{
text: "Build on and extend Plane",
items: [
{
text: "Agents",
link: "/dev-tools/agents/overview",
collapsed: false,
items: [
{ text: "Building an agent", link: "/dev-tools/agents/building-an-agent" },
{ text: "Best practices", link: "/dev-tools/agents/best-practices" },
{ text: "Signals and content payload", link: "/dev-tools/agents/signals-content-payload" },
],
},
{
text: "Build Plane App",
link: "/dev-tools/build-plane-app/overview",
collapsed: false,
items: [
{ text: "Create an OAuth application", link: "/dev-tools/build-plane-app/create-oauth-application" },
{ text: "Choose token Flow", link: "/dev-tools/build-plane-app/choose-token-flow" },
{ text: "Handling webhooks", link: "/dev-tools/build-plane-app/webhooks" },
{ text: "OAuth scopes", link: "/dev-tools/build-plane-app/oauth-scopes" },
{ text: "SDKs", link: "/dev-tools/build-plane-app/sdks" },
{ text: "Complete examples", link: "/dev-tools/build-plane-app/examples" },
],
},
{
text: "MCP Server",
link: "/dev-tools/mcp-server",
collapsed: false,
items: [{ text: "For Claude Code", link: "/dev-tools/mcp-server-claude-code" }],
},
{ text: "Plane Compose", link: "/dev-tools/plane-compose" },
{ text: "OpenAPI Specification", link: "/dev-tools/openapi-specification" },
{ text: "Webhooks", link: "/dev-tools/intro-webhooks" },
],
},
],
},
socialLinks: [
{ icon: "github", link: "https://github.com/makeplane/plane" },
{ icon: "discord", link: "https://discord.com/invite/A92xrEGCge" },
{ icon: "twitter", link: "https://twitter.com/planepowers" },
{ icon: "linkedin", link: "https://www.linkedin.com/company/planepowers/" },
],
search: searchConfig,
editLink: {
pattern: "https://github.com/makeplane/developer-docs/edit/main/:path",
},
/*footer: {
message: 'Released under the Apache License 2.0.',
copyright: 'Copyright © 2024 Plane'
}*/
},
})
);