docs-plugin/src/plugin.json at a618d437240c14c74d008248dd0c7640f2d5c45e · mckn/docs-plugin · GitHub

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
{
  "$schema": "https://raw.githubusercontent.com/grafana/grafana/main/docs/sources/developers/plugins/plugin.schema.json",
  "type": "app",
  "name": "Grafana Pathfinder",
  "id": "grafana-grafanadocsplugin-app",
  "backend": false,
  "autoEnabled": true,
  "info": {
    "keywords": ["app", "documentation", "learning", "command palette", "search"],
    "description": "A learning journey plugin that provides contextual help and interactive learning experiences",
    "screenshots": [
      { "name": "Recommended reading", "path": "img/screenshot_1.png" },
      { "name": "Progress through reading", "path": "img/screenshot_2.png" }
    ],
    "author": {
      "name": "Grafana"
    },
    "logos": {
      "small": "img/logo.svg",
      "large": "img/logo.svg"
    },
    "version": "%VERSION%",
    "updated": "%TODAY%"
  },
  "includes": [
    {
      "type": "page",
      "name": "Grafana Pathfinder",
      "path": "/a/grafana-grafanadocsplugin-app",
      "action": "grafana-grafanadocsplugin-app.docs:read",
      "addToNav": false,
      "defaultNav": false
    }
  ],
  "extensions": {
    "addedComponents": [
      {
        "targets": ["grafana/extension-sidebar/v0-alpha"],
        "description": "Opens Grafana Pathfinder",
        "title": "Grafana Pathfinder"
      }
    ],
    "exposedComponents": [
      {
        "id": "grafana-grafanadocsplugin-app/pathfinder-help/v1",
        "title": "Grafana Pathfinder",
        "description": "Grafana Pathfinder documentation assistant"
      }
    ],
    "addedLinks": [
      {
        "targets": ["grafana/extension-sidebar/v0-alpha"],
        "description": "Opens Grafana Pathfinder",
        "title": "Documentation-Link"
      },
      {
        "targets": ["grafana/app/topbar/help/v1"],
        "description": "Open Grafana Pathfinder documentation assistant",
        "title": "Grafana Pathfinder"
      },
      {
        "targets": ["grafana/commandpalette/action"],
        "description": "Open Grafana Pathfinder",
        "title": "Open Grafana Pathfinder"
      },
      {
        "targets": ["grafana/commandpalette/action"],
        "description": "Get help with Grafana",
        "title": "Need help?"
      },
      {
        "targets": ["grafana/commandpalette/action"],
        "description": "Learn how to use Grafana",
        "title": "Learn Grafana"
      }
    ]
  },
  "dependencies": {
    "grafanaDependency": ">=12.1.0",
    "plugins": []
  },
  "roles": [
    {
      "grants": ["Viewer"],
      "role": {
        "name": "Pathfinder User",
        "description": "Access to Grafana Pathfinder",
        "permissions": [
          {
            "action": "plugins.app:access",
            "scope": "plugins:id:grafana-grafanadocsplugin-app"
          },
          {
            "action": "grafana-grafanadocsplugin-app.docs:read"
          }
        ]
      }
    }
  ],
  "languages": [
    "en-US",
    "id-ID",
    "cs-CZ",
    "de-DE",
    "es-ES",
    "fr-FR",
    "it-IT",
    "hu-HU",
    "nl-NL",
    "pl-PL",
    "pt-PT",
    "pt-BR",
    "sv-SE",
    "tr-TR",
    "ru-RU",
    "ko-KR",
    "zh-CN",
    "zh-TW",
    "zh-Hans",
    "zh-Hant",
    "ja-JP"
  ]
}