Skip to content

Commit c7d895e

Browse files
committed
docs: Update links to APIs in the plugin functionality page
Signed-off-by: Oleksandr Dubenko <[email protected]>
1 parent 7fd0708 commit c7d895e

File tree

1 file changed

+28
-28
lines changed
  • docs/development/plugins/functionality

1 file changed

+28
-28
lines changed

docs/development/plugins/functionality/index.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ These are:
4040
Thus, plugins only need to install dependencies that are not yet provided by Headlamp.
4141
If any dependencies already covered by Headlamp are installed by the plugins, ensure
4242
that they are the same version that Headlamp supports. These will not be bundled when
43-
[building the plugin](./building.md).
43+
[building the plugin](../building.md).
4444
Particularly, the mentioned modules will be replaced by their version that's included
4545
in a global object called `pluginLib`.
4646

@@ -57,118 +57,118 @@ what we have so far:
5757
### App Bar Action
5858

5959
Show a component in the app bar (in the top right) with
60-
[registerAppBarAction](../api/plugin/registry/functions/registerappbaraction).
60+
[registerAppBarAction](../../api/plugin/registry/functions/registerappbaraction).
6161

6262
![screenshot of the header showing two actions](../images/podcounter_screenshot.png)
6363

6464
- Example plugin shows [How To Register an App Bar Action](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/pod-counter)
65-
- API reference for [registerAppBarAction](../api/plugin/registry/functions/registerappbaraction)
65+
- API reference for [registerAppBarAction](../../api/plugin/registry/functions/registerappbaraction)
6666

6767
### App Logo
6868

6969
Change the logo (at the top left) with
70-
[registerAppLogo](../api/plugin/registry/functions/registerapplogo).
70+
[registerAppLogo](../../api/plugin/registry/functions/registerapplogo).
7171

7272
![screenshot of the logo being changed](../images/change-logo.png)
7373

7474
- Example plugin shows [How To Change The Logo](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/change-logo)
75-
- API reference for [registerAppLogo](../api/plugin/registry/functions/registerapplogo)
75+
- API reference for [registerAppLogo](../../api/plugin/registry/functions/registerapplogo)
7676

7777
### App Menus
7878

7979
Add menus when Headlamp is running as an app.
80-
[Headlamp.setAppMenu](../api/plugin/lib/classes/Headlamp#setappmenu)
80+
[Headlamp.setAppMenu](../../api/plugin/lib/classes/Headlamp#setappmenu)
8181

8282
![screenshot of the logo being changed](../images/app-menus.png)
8383

8484
- Example plugin shows [How To Add App Menus](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/app-menus)
85-
- API reference for [Headlamp.setAppMenu](../api/plugin/lib/classes/Headlamp#setappmenu)
85+
- API reference for [Headlamp.setAppMenu](../../api/plugin/lib/classes/Headlamp#setappmenu)
8686

8787
### Cluster Chooser
8888

8989
Change the Cluster Chooser button (in the middle top of the Headlamp app bar) with
90-
[registerClusterChooser](../api/plugin/registry/functions/registerclusterchooser).
90+
[registerClusterChooser](../../api/plugin/registry/functions/registerclusterchooser).
9191

9292
![screenshot of the cluster chooser button](../images/cluster-chooser.png)
9393

9494
- Example plugin shows [How To Register Cluster Chooser button](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/clusterchooser)
95-
- API reference for [registerClusterChooser](../api/plugin/registry/functions/registerclusterchooser)
95+
- API reference for [registerClusterChooser](../../api/plugin/registry/functions/registerclusterchooser)
9696

9797
### Details View Header Action
9898

9999
Show a component to the top right area of a detail view
100100
(in the area of the screenshot below that's highlighted as yellow)
101-
[registerDetailsViewHeaderAction](../api/plugin/registry/functions/registerdetailsviewheaderaction).
101+
[registerDetailsViewHeaderAction](../../api/plugin/registry/functions/registerdetailsviewheaderaction).
102102

103103
![screenshot of the header showing two actions](../images/header_actions_screenshot.png)
104104

105105
- Example plugin shows [How To set a Details View Header Action](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/details-view)
106-
- API reference for [registerDetailsViewHeaderAction](../api/plugin/registry/functions/registerdetailsviewheaderaction)
106+
- API reference for [registerDetailsViewHeaderAction](../../api/plugin/registry/functions/registerdetailsviewheaderaction)
107107

108108
### Details View Section
109109

110-
Change sections in cluster resources' details views with [registerDetailsViewSectionsProcessor](../api/plugin/registry/functions/registerdetailsviewsectionsprocessor). This allows you to remove, add, update, or shuffle sections within details views, including the back link.
110+
Change sections in cluster resources' details views with [registerDetailsViewSectionsProcessor](../../api/plugin/registry/functions/registerdetailsviewsectionsprocessor). This allows you to remove, add, update, or shuffle sections within details views, including the back link.
111111

112112
Or simply append a component at the bottom of different details views with
113-
[registerDetailsViewSection](../api/plugin/registry/functions/registerdetailsviewsection).
113+
[registerDetailsViewSection](../../api/plugin/registry/functions/registerdetailsviewsection).
114114

115115
![screenshot of the appended Details View Section](../images/details-view.jpeg)
116116

117117
- Example plugin shows [How To set a Details View Section](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/details-view)
118-
- API reference for [registerDetailsViewSection](../api/plugin/registry/functions/registerdetailsviewsection)
118+
- API reference for [registerDetailsViewSection](../../api/plugin/registry/functions/registerdetailsviewsection)
119119

120120
### Dynamic Clusters
121121

122122
Set a cluster dynamically, rather than have the backend read it from configuration files.
123-
[Headlamp.setCluster](../api/plugin/lib/classes/Headlamp.md#setcluster).
123+
[Headlamp.setCluster](../../api/plugin/lib/classes/Headlamp.md#setcluster).
124124

125125
- Example plugin shows [How To Dynamically Set a Cluster](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/dynamic-clusters)
126-
- API reference for [Headlamp.setCluster](../api/plugin/lib/classes/Headlamp.md#setcluster)
126+
- API reference for [Headlamp.setCluster](../../api/plugin/lib/classes/Headlamp.md#setcluster)
127127

128128
### Route
129129

130130
Show a component (in Headlamps main area) at a given URL with
131-
[registerRoute](../api/plugin/registry/functions/registerroute).
131+
[registerRoute](../../api/plugin/registry/functions/registerroute).
132132

133133
- Example plugin shows [How To Register a Route](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/sidebar), and how to remove a route.
134-
- API reference for [registerRoute](../api/plugin/registry/functions/registerroute)
135-
- API reference for [registerRouteFilter](../api/plugin/registry/functions/registerroutefilter)
134+
- API reference for [registerRoute](../../api/plugin/registry/functions/registerroute)
135+
- API reference for [registerRouteFilter](../../api/plugin/registry/functions/registerroutefilter)
136136

137137
### Sidebar Item
138138

139139
Add sidebar items (menu on the left) with
140-
[registerSidebarEntry](../api/plugin/registry/functions/registersidebarentry).
141-
Remove sidebar items with [registerSidebarEntryFilter](../api/plugin/registry/functions/registersidebarentryfilter).
140+
[registerSidebarEntry](../../api/plugin/registry/functions/registersidebarentry).
141+
Remove sidebar items with [registerSidebarEntryFilter](../../api/plugin/registry/functions/registersidebarentryfilter).
142142

143143
![screenshot of the sidebar being changed](../images/sidebar.png)
144144

145145
- Example plugin shows [How To add items to the sidebar](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/sidebar), and also how to remove sidebar items.
146-
- API reference for [registerSidebarEntry](../api/plugin/registry/functions/registersidebarentry)
147-
- API reference for [registerSidebarEntryFilter](../api/plugin/registry/functions/registersidebarentryfilter)
146+
- API reference for [registerSidebarEntry](../../api/plugin/registry/functions/registersidebarentry)
147+
- API reference for [registerSidebarEntryFilter](../../api/plugin/registry/functions/registersidebarentryfilter)
148148

149149
### Tables
150150

151-
Change what tables across Headlamp show with [registerResourceTableColumnsProcessor](../api/plugin/registry/functions/registersidebarentry). This allows you to remove, add, update, or shuffle table columns.
151+
Change what tables across Headlamp show with [registerResourceTableColumnsProcessor](../../api/plugin/registry/functions/registersidebarentry). This allows you to remove, add, update, or shuffle table columns.
152152

153153
![screenshot of the pods list with a context menu added by a plugin](../images/table-context-menu.png)
154154

155155
- Example plugin shows [How to add a context menu to each row in the pods list table](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/tables).
156-
- API reference for [registerResourceTableColumnsProcessor](../api/plugin/registry/functions/registerresourcetablecolumnsprocessor)
156+
- API reference for [registerResourceTableColumnsProcessor](../../api/plugin/registry/functions/registerresourcetablecolumnsprocessor)
157157

158158
### Headlamp Events
159159

160160
Headlamp has the concept of "Headlamp events". Those are fired when something relevant happens in Headlamp.
161161

162-
React to Headlamp events with [registerHeadlampEventCallback](../api/plugin/registry/functions/registerheadlampeventcallback).
162+
React to Headlamp events with [registerHeadlampEventCallback](../../api/plugin/registry/functions/registerheadlampeventcallback).
163163

164164
![screenshot of a snackbar notification when an event occurred](../images/event-snackbar.png)
165165

166166
- Example plugin shows [How to show snackbars for Headlamp events](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/headlamp-events).
167-
- API reference for [registerHeadlampEventCallback](../api/plugin/registry/functions/registerheadlampeventcallback)
167+
- API reference for [registerHeadlampEventCallback](../../api/plugin/registry/functions/registerheadlampeventcallback)
168168

169169
### Plugin Settings
170170

171-
The plugins can have user-configurable settings that can be used to change the behavior of the plugin. The plugin settings can be created using [registerPluginSettings](../api/plugin/registry/functions/registerpluginsettings).
171+
The plugins can have user-configurable settings that can be used to change the behavior of the plugin. The plugin settings can be created using [registerPluginSettings](../../api/plugin/registry/functions/registerpluginsettings).
172172

173173
- Example plugin shows [How to create plugin settings and use them](https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/change-logo)
174174

0 commit comments

Comments
 (0)