Skip to content

Commit c877a45

Browse files
Fully rework and expand the admin panel API part of the plugins development documentation (#2920)
* adding an admin configuration and customization page * refreshing the create a plugin page * Restore create-a-plugin.md content to match `main` branch content * Add dedicated pages for sub-topics * Restore snippet from `main` branch * Rework admin config. & custom. page * Rework admin-panel-api to point to new sub-topics * Fix URL in content-manager-apis.md * Re-organize sidebar * Rework the Admin Panel API page to simplify it and act as a hub * Add missing cards to guides in developing-plugins.md * Rework again Admin Panel API * Add admin localization page * Add reusable snippets for all plugins pages prerequisites * Delete old "admin config & custom" page replaced by admin-navigation-settings.md * Add admin-navigation-settings.md page * Rename some page titles + improve intros * Optimize sidebar * Fix parallel naming for headings in admin-localization * Add admin-localization page * Use prerequisite snippet in Admin Panel API overview * Link Admin Panel API to admin panel customization * Add missing tags * Improve localization page * Improve navigation & settings page * Improve Admin Panel API overview * Improve Content Manager APIs * Update sidebar to match order in Admin Panel overview * Hide old tip from admin panel custom. section in sidebar * Add missing loading property to a CM API example * Improve further admin-navigation-settings with considerations about `to` and security caution and `permissions * Rework injection zones page * Improve injection zones further and fix deprecated hook example * Improve Redux store & reducers page * Improve Redux store page further * Improve Redux store page further based on Codex recommendations * Add tl;dr to injection zones vs. CM APIs snippet * Rework the admin-injection-zones prereq. based on prev. snippet * Improve tags & intro. for CM APIs page * Fix prev. pagination for CM APIs page * Rework admin hooks page * Improve formatting in hooks page * Use ExternalLink in injection zones vs. CM APIs snippet * Refine hooks end-of-page note * Fix tags for admin localization * Refine Server API cross link with Admin Panel API * Further refine some admin-localization notes (merge order, programmatic access) * Fix invalid comment in JSON example for admin-localization * Fix broken links & anchors * Fix more broken links & anchors * Fix pagination for admin hooks * Fix snippet mismatching heading levels * Fix sidebar * Remove registerTrads from admin panel API overview * Fix wrong link in developing plugins guides cards * Fix missing word in Server API intro * Fix hyphenation in Server API intro. * Fix code example in snippet for injection zones vs. CM APIs * Fix sidebar (missing plugin structure page) * Fix paginations * Fix admin permissions for plugins example * Add small fixes for Store and access data guide * Add small fix for Pass data from server to admin guide * Add small fixes for create components for plugins guides --------- Co-authored-by: Pierre Wizla <4233866+pwizla@users.noreply.github.com>
1 parent 56d5bee commit c877a45

26 files changed

Lines changed: 2883 additions & 1071 deletions

docusaurus/docs/cms/admin-panel-customization.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Admin panel customization is done by tweaking the code of the `src/admin/app` fi
2525
- Replace some other parts of the admin panel, such as the Rich text editor and the bundler,
2626
- Extend the theme or the admin panel to add new features or customize the existing user interface.
2727

28+
:::strapi Plugins and Admin Panel API
29+
In addition to supported customizations detailed in this section, you can go further and create plugins that tap into the [Admin Panel API](/cms/plugins-development/admin-panel-api).
30+
:::
31+
2832
## General considerations
2933

3034
:::prerequisites
@@ -84,6 +88,7 @@ The `config` object of `/src/admin/app` accepts the following parameters:
8488
| `tutorials` | Boolean | Toggles displaying the video tutorials
8589
| `notifications` | Object | Accepts the `releases` key (Boolean) to toggle displaying notifications about new releases |
8690

91+
<br/>
8792
Click on any of the following cards to get more details about a specific topic:
8893

8994
<CustomDocCardsWrapper>

docusaurus/docs/cms/api/content-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Content API
33
description: Learn more about Strapi 5's Content API
44
displayed_sidebar: cmsSidebar
5-
sidebar_label: APIs Introduction
5+
sidebar_label: Content APIs Introduction
66
pagination_prev: cms/setup-deployment
77
pagination_next: cms/api/document
88
tags:

docusaurus/docs/cms/migration/v4-to-v5/breaking-changes/edit-view-layout-and-list-view-layout-rewritten.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The `content-manager_editViewLayoutManager` and `content-manager_listViewLayoutM
4848

4949
### Notes
5050

51-
Additional information about hooks can be found in the [Admin Panel API for plugins](/cms/plugins-development/admin-panel-api#hooks-api) documentation.
51+
Additional information about hooks can be found in the [Admin Panel API for plugins](/cms/plugins-development/admin-hooks) documentation.
5252

5353
### Manual procedure
5454

docusaurus/docs/cms/migration/v4-to-v5/breaking-changes/inject-content-manager-component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import MigrationIntro from '/docs/snippets/breaking-change-page-migration-intro.
1515

1616
# `injectContentManagerComponent()` removed
1717

18-
In Strapi 5, the `injectContentManagerComponent` method is removed because the Content Manager is now a plugin. The [Admin Panel API](/cms/plugins-development/admin-panel-api#injecting-components) method is replaced by `getPlugin('content-manager').injectComponent()`.
18+
In Strapi 5, the `injectContentManagerComponent` method is removed because the Content Manager is now a plugin. The [Admin Panel API](/cms/plugins-development/admin-injection-zones) method is replaced by `getPlugin('content-manager').injectComponent()`.
1919

2020
<Intro />
2121
<BreakingChangeIdCard plugins />

docusaurus/docs/cms/migration/v4-to-v5/breaking-changes/license-only.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ A similar result can be achieved in Strapi v4 by adding the `lockIcon` property.
5858

5959
- a settings menu item will look like the following: ![](/img/assets/plugins/lightning-icon-settings.png)
6060

61-
* Additional information and examples on how to use the `licenseOnly` property can be found in the [`addMenuLink()`](/cms/plugins-development/admin-panel-api#menu-api), [`addSettingsLink()`](/cms/plugins-development/admin-panel-api#addsettingslink), and [`addSettingsLinks()`](/cms/plugins-development/admin-panel-api#addsettingslinks) methods sections of the Admin Panel API documentation.
61+
* Additional information and examples on how to use the `licenseOnly` property can be found in the [`addMenuLink()`](/cms/plugins-development/admin-navigation-settings#navigation-sidebar-menu-links), [`addSettingsLink()`](/cms/plugins-development/admin-navigation-settings#adding-links-to-existing-settings-sections), and [`addSettingsLinks()`](/cms/plugins-development/admin-navigation-settings#adding-links-to-existing-settings-sections) methods sections of the Admin Panel API documentation.
6262

6363
### Manual migration
6464

docusaurus/docs/cms/migration/v4-to-v5/breaking-changes/react-router-dom-6.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import MigrationIntro from '/docs/snippets/breaking-change-page-migration-intro.
1515

1616
# Strapi users `react-router-dom` v6
1717

18-
Strapi 5 uses <ExternalLink to="https://www.npmjs.com/package/react-router-dom" text="`react-router-dom`"/> v6. This impacts the links added to [settings](/cms/plugins-development/admin-panel-api#settings-api) or to the [menu](/cms/plugins-development/admin-panel-api#menu-api) using the Admin Panel API.
18+
Strapi 5 uses <ExternalLink to="https://www.npmjs.com/package/react-router-dom" text="`react-router-dom`"/> v6. This impacts the links added to [settings](/cms/plugins-development/admin-navigation-settings#settings) or to the [menu](/cms/plugins-development/admin-navigation-settings#navigation-sidebar-menu-links) using the Admin Panel API.
1919

2020
<Intro />
2121

@@ -61,4 +61,4 @@ Strapi 5 uses <ExternalLink to="https://www.npmjs.com/package/react-router-dom"
6161
### Manual procedure
6262

6363
This breaking change should be handled by a codemod (see the <ExternalLink to="https://github.com/strapi/strapi/tree/develop/packages/utils/upgrade/resources/codemods/5.0.0" text="full list of 5.0.0 codemods"/>).
64-
Ensure that links added to [settings](/cms/plugins-development/admin-panel-api#settings-api) or to the [menu](/cms/plugins-development/admin-panel-api#menu-api) links using the Admin Panel API use relative paths.
64+
Ensure that links added to [settings](/cms/plugins-development/admin-navigation-settings#settings) or to the [menu](/cms/plugins-development/admin-navigation-settings#navigation-sidebar-menu-links) links using the Admin Panel API use relative paths.

0 commit comments

Comments
 (0)