inveniosoftware · Samk13 · Apr 2, 2024 · Apr 2, 2024 · Jun 10, 2024 · fenekku
diff --git a/docs/customize/metadata/custom_fields/records.md b/docs/customize/metadata/custom_fields/records.md
@@ -280,10 +280,10 @@ RDM_CUSTOM_FIELDS_UI = [
 
 You should add the `my_template.html` file in the `my-site/templates` folder in your instance. In your custom template, the following variables are injected and can be used:
 
-- `field_value`: the value of the field, as it is stored in the record after the UI serialization i.e. what is returned from the `ui_field` method when you [define your custom field](../../../develop/howtos/custom_fields.md).
+- `field_value`: the value of the field, as it is stored in the record after the UI serialization i.e. what is returned from the `ui_field` method when you [define your custom field](../../../howtos/custom_fields.md).
 - `field_cfg`: the UI configuration for that specific field as it is defined in the `RDM_CUSTOM_FIELDS_UI` config.
 
-See the example in the [How-to](../../../develop/howtos/custom_fields.md#define-the-template-for-the-record-landing-page).
+See the example in the [How-to](../../../howtos/custom_fields.md#define-the-template-for-the-record-landing-page).
 
 ### Search
 

diff --git a/docs/customize/other-pids/urns.md b/docs/customize/other-pids/urns.md
@@ -101,7 +101,7 @@ XMETADISS_TYPE_DCTERMS_DCMITYPE = "openaire_type"
 ```
 
 In order to fully implement xMetaDissPlus with all mandatory fields, the metadata definition has to be expanded by [custom
-fields](../../develop/howtos/custom_fields.md).
+fields](../../howtos/custom_fields.md).
 At first add the file `thesis_types.yaml` to `/app_data/vocabularies` (you will find the content [here](https://raw.githubusercontent.com/ulbmuenster/invenio-dnb-urn/main/thesis_types.yaml)):
 
 ```yaml

diff --git a/docs/develop/best-practices/commits.md b/docs/develop/best-practices/commits.md
@@ -103,8 +103,8 @@ When making your pull request, please keep the following in mind:
 - Add tests and don't decrease test coverage.
 - Add documentation.
 - Follow our best practices:
-    - [Data migrations](../howtos/alembic.md)
-    - [Translation strings](../howtos/i18n.md)
+    - [Data migrations](../../howtos/alembic.md)
+    - [Translation strings](../../howtos/i18n.md)
     - [CSS/JS](css-js.md) and [React](react.md)
     - [Web accessibility](accessibility.md)
     - [User interface](ui.md)

diff --git a/docs/develop/best-practices/react.md b/docs/develop/best-practices/react.md
@@ -89,7 +89,7 @@ render() {
 
 ### On Overridable
 
-See the [How to override UI React components](../howtos/override_components.md) how-to for detailed explanations on the library itself.
+See the [How to override UI React components](../../howtos/override_components.md) how-to for detailed explanations on the library itself.
 
 The library allows developers to mark components that can be overridden. While it is very easy to use, it can also lead to subtle errors.
 

diff --git a/docs/develop/index.md b/docs/develop/index.md
@@ -25,7 +25,7 @@ Development guidelines for specific areas of development.
 - [Commits, pull requests and reviews](best-practices/commits.md)
 - [CSS/JavaScript](best-practices/css-js.md)
 - [React](best-practices/react.md)
-- [Translation (i18n)](howtos/i18n.md)
+- [Translation (i18n)](../howtos/i18n.md)
 - [User interface](best-practices/ui.md)
 
 ## Topics
@@ -44,15 +44,7 @@ Developer introductions to specific parts of the InvenioRDM source code:
 
 Step-by-step guides on how to perform certain tasks:
 
-- [Create a new custom field](howtos/custom_fields.md)
-- [Create custom code and views](howtos/custom_code.md)
-- [Add JavaScript](howtos/add_javascript.md)
-- [Override UI React components](howtos/override_components.md)
-- [Create search terms mappings](howtos/search_terms_migration.md)
-- [Create a database migration](howtos/alembic.md)
-- [Fix a vulnerability](howtos/security-fix.md)
-- [Test emails locally](howtos/dev_email.md)
-- [Migrate legacy routes](howtos/route_migration.md)
+- [How to guides section](../howtos/index.md)
 
 ## Architecture
 

diff --git a/docs/develop/howtos/add_javascript.md → docs/howtos/add_javascript.md b/docs/develop/howtos/add_javascript.md → docs/howtos/add_javascript.md
diff --git a/docs/howtos/administration/index.md b/docs/howtos/administration/index.md
@@ -0,0 +1,59 @@
+# Accessing the Administration Panel
+
+The following detailing the administration panel setup, how to add users and its interface and usage.
+
+## Prerequisites
+
+To access the Administration Panel, users must be logged in with an administrator role. The admin role is key to performing administrative tasks and is assigned from the instance's owners.
+
+## Setup
+
+Setting up access to the Administration Panel involves configuring the instance, creating roles, allowing these roles, and assigning them to users by instance's owners.
+
+### Configuration
+
+Firstly, ensure that the Administration Panel is enabled in your instance by adding the following configuration in `invendio.cfg`:
+
+```python
+USERS_RESOURCES_ADMINISTRATION_ENABLED = True
+```
+
+### Creating and Allowing Roles
+
+Execute the following commands to create the necessary roles and permissions:
+
+```shell
+# Create and allow the roles once (usually done in the instance setup)
+invenio roles create administration-moderation
+invenio roles create administration
+
+invenio access allow administration-moderation role administration-moderation
+invenio access allow administration-access role administration
+invenio access allow superuser-access role administration
+```
+
+### Assigning Roles to Users
+
+To grant a user access to the Administration Panel, assign the administration role:
+
+```shell
+# allow the user to access the administration panel
+invenio roles add user@demo.org administration
+```
+
+You can assign the moderation role to a admin if you want to allow access the users moderation panel:
+
+```shell
+# allow the user to access the moderation tab
+invenio roles add user@demo.org administration-moderation
+```
+
+replace `user@demo.org` with the email of the user you want to give access to the administration panel.
+
+## More Information
+
+You can find more information about the Administration Panel in the following sections:
+
+- [Architecture](../../develop/topics/administration_panel.md/#administration-panel)
+
+- [References](../../reference/administration_reference.md/#administration-reference-guide)
diff --git a/docs/howtos/administration/interface.md b/docs/howtos/administration/interface.md
@@ -0,0 +1,3 @@
+# Administration Interface
+
+The administration interface is a powerful tool that allows you to manage your InvenioRDM instance. It is accessible to users with the role of administrator.
diff --git a/docs/develop/howtos/alembic.md → docs/howtos/alembic.md b/docs/develop/howtos/alembic.md → docs/howtos/alembic.md
diff --git a/docs/develop/howtos/backup_search_indices.md → docs/howtos/backup_search_indices.md b/docs/develop/howtos/backup_search_indices.md → docs/howtos/backup_search_indices.md
diff --git a/docs/develop/howtos/custom_code.md → docs/howtos/custom_code.md b/docs/develop/howtos/custom_code.md → docs/howtos/custom_code.md
diff --git a/docs/develop/howtos/custom_fields.md → docs/howtos/custom_fields.md b/docs/develop/howtos/custom_fields.md → docs/howtos/custom_fields.md
@@ -2,7 +2,7 @@
 
 *Introduced in InvenioRDM v10*
 
-This guide describes how to create your own custom field. If you have not done it yet, please read first about configuring [records custom fields](../../customize/metadata/custom_fields/records.md).
+This guide describes how to create your own custom field. If you have not done it yet, please read first about configuring [records custom fields](../customize/metadata/custom_fields/records.md).
 The new custom field in this example will extend the use case described in the records custom field documentation:
 
 _When uploading a research preprint at CERN, I want to record the title and the research program of the related CERN experiments._
@@ -143,7 +143,7 @@ export class Experiments extends Component {
 }
 ```
 
-Since we added a new Javascript file, we need to [rebuild our assets](../../customize/look-and-feel/theme.md#automatic-re-build):
+Since we added a new Javascript file, we need to [rebuild our assets](../customize/look-and-feel/theme.md#automatic-re-build):
 
 ```bash
 $ invenio-cli assets build
@@ -214,10 +214,10 @@ $ pipenv run invenio rdm-records custom-fields init -f experiments
 
 The new field will be displayed at the bottom of the upload form:
 
-![Experiments field upload form](../img/new_custom_field_upload_form.png)
+![Experiments field upload form](img/new_custom_field_upload_form.png)
 
 ### Record landing page
 
 The new field will be displayed in the record landing page:
 
-![Experiments field record landing page](../img/new_custom_field_landing_page.png)
+![Experiments field record landing page](img/new_custom_field_landing_page.png)
diff --git a/docs/develop/howtos/dev_email.md → docs/howtos/dev_email.md b/docs/develop/howtos/dev_email.md → docs/howtos/dev_email.md
diff --git a/docs/develop/howtos/i18n.md → docs/howtos/i18n.md b/docs/develop/howtos/i18n.md → docs/howtos/i18n.md
diff --git a/...lop/howtos/img/metadata_only_checkbox.png → docs/howtos/img/metadata_only_checkbox.png b/...lop/howtos/img/metadata_only_checkbox.png → docs/howtos/img/metadata_only_checkbox.png
diff --git a/...velop/howtos/img/metadata_only_toggle.png → docs/howtos/img/metadata_only_toggle.png b/...velop/howtos/img/metadata_only_toggle.png → docs/howtos/img/metadata_only_toggle.png
diff --git a/...ysite_custom_views/mysite_custom_view.png → ...ysite_custom_views/mysite_custom_view.png b/...ysite_custom_views/mysite_custom_view.png → ...ysite_custom_views/mysite_custom_view.png
diff --git a/...site_custom_views/mysite_support_page.png → ...site_custom_views/mysite_support_page.png b/...site_custom_views/mysite_support_page.png → ...site_custom_views/mysite_support_page.png
diff --git a/...lop/img/new_custom_field_landing_page.png → ...tos/img/new_custom_field_landing_page.png b/...lop/img/new_custom_field_landing_page.png → ...tos/img/new_custom_field_landing_page.png
diff --git a/...elop/img/new_custom_field_upload_form.png → ...wtos/img/new_custom_field_upload_form.png b/...elop/img/new_custom_field_upload_form.png → ...wtos/img/new_custom_field_upload_form.png
diff --git a/...s/img/react_browser_extension_example.png → ...s/img/react_browser_extension_example.png b/...s/img/react_browser_extension_example.png → ...s/img/react_browser_extension_example.png
diff --git a/docs/howtos/index.md b/docs/howtos/index.md
@@ -0,0 +1,24 @@
+# How-to Guides
+
+Step-by-step guides on how to perform certain tasks:
+
+## User Guides
+
+Check out the [User Guides](https://help.zenodo.org/docs/) section on Zenodo.org.
+
+## Instance Administrators
+
+- [Accessing the Administration Panel](administration/index.md)
+- [Moderate users](administration/interface.md)
+
+## Development and Customization
+
+- [Create a new custom field](custom_fields.md)
+- [Create custom code and views](custom_code.md)
+- [Add JavaScript](add_javascript.md)
+- [Override UI React components](override_components.md)
+- [Create search terms mappings](search_terms_migration.md)
+- [Create a database migration](alembic.md)
+- [Fix a vulnerability](security-fix.md)
+- [Test emails locally](dev_email.md)
+- [Migrate legacy routes](route_migration.md)
diff --git a/docs/develop/howtos/override_components.md → docs/howtos/override_components.md b/docs/develop/howtos/override_components.md → docs/howtos/override_components.md
@@ -16,7 +16,7 @@ For this guide, we assume that you are familiar with React and JavaScript.
     **Use it at your own risk!**
 
 The UI of InvenioRDM is composed of classic HTML web pages for mostly static content, and React web apps for very dynamic content to enhance the user experience.
-While a [dedicated guide](../../customize/look-and-feel/templates.md) describes how to override HTML web pages (Jinja templates), this guide focus on how to override React components.
+While a [dedicated guide](../customize/look-and-feel/templates.md) describes how to override HTML web pages (Jinja templates), this guide focus on how to override React components.
 
 InvenioRDM uses the React library [`react-overridable`](https://github.com/indico/react-overridable). The library provides a mechanism to mark React components as "overridable" by id.
 Developers can define a map `{ id: Overridden React component }`, which is then applied when each React component is rendered: the overridden component is rendered instead of the default one.
@@ -35,7 +35,7 @@ At the moment, the easiest way to understand how to identify if the component th
 
 You can then find the component in the InvenioRDM modules source code, searching it in your local development environment or using the search feature in GitHub in the [inveniosoftware organization](https://github.com/search?q=org%3Ainveniosoftware+FileUploaderToolbar&type=code).
 
-You can always [ask for help](../../develop/getting-started/help.md)!
+You can always [ask for help](../develop/getting-started/help.md)!
 
 ### Find the React Overridable ID
 

diff --git a/docs/develop/howtos/route_migration.md → docs/howtos/route_migration.md b/docs/develop/howtos/route_migration.md → docs/howtos/route_migration.md
diff --git a/.../develop/howtos/search_terms_migration.md → docs/howtos/search_terms_migration.md b/.../develop/howtos/search_terms_migration.md → docs/howtos/search_terms_migration.md
diff --git a/docs/develop/howtos/security-fix.md → docs/howtos/security-fix.md b/docs/develop/howtos/security-fix.md → docs/howtos/security-fix.md
@@ -36,7 +36,7 @@ to determine the CVE score and select
 ## Step 5 - Identify supported versions
 
 Next, identify all supported versions of the module using the
-[branch management](../../maintenance/branch-management.md) and take note of which branch(es)
+[branch management](../maintenance/branch-management.md) and take note of which branch(es)
 you have to apply the fix to.
 
 ## Step 6 - Create a private temporary fork

diff --git a/docs/reference/statistics.md b/docs/reference/statistics.md
@@ -10,7 +10,7 @@ designed to be compatible with the [COUNTER Code of Practice Release 4](https://
     All information related to statistics (i.e. the raw events and aggregations) are stored
     exclusively in search indices and not in the database, which makes search engine backups
     much more relevant.
-    Some recommendations are given in the [how-to section](../develop/howtos/backup_search_indices.md).
+    Some recommendations are given in the [how-to section](../howtos/backup_search_indices.md).
 
 ## Inner workings
 

diff --git a/docs/releases/upgrading/upgrade-v11.0.md b/docs/releases/upgrading/upgrade-v11.0.md
@@ -123,7 +123,7 @@ You can see how to update your data in the [Funders vocabulary section](../../cu
 ### Update `my-site` folder
 
 With InvenioRDM v11, the template to generate a new instance has been updated, adding more files and folders.
-It is now easier to add [translations](../../contribute/translators-guide.md) and [custom code](../../develop/howtos/custom_code.md).
+It is now easier to add [translations](../../contribute/translators-guide.md) and [custom code](../../howtos/custom_code.md).
 
 To upgrade your running instance and have the same new files, the easiest way is to:
 

diff --git a/docs/releases/versions/version-v10.0.0.md b/docs/releases/versions/version-v10.0.0.md
@@ -20,7 +20,7 @@ In addition to the many bugs fixed, this release introduces custom fields both f
 
 You can now add custom fields to [bibliographic records](https://inveniordm.docs.cern.ch/customize/metadata/custom_fields/records/) and [communities](https://inveniordm.docs.cern.ch/customize/metadata/custom_fields/communities/) data models. InvenioRDM supports a wide variety of field types and UI widgets: you can find the full list in the [custom fields](https://inveniordm.docs.cern.ch/customize/custom_fields/records/#reference) and the [UI widgets](https://inveniordm.docs.cern.ch/reference/widgets/) documentation pages.
 
-You can also extend the default components or implement your owns. To get more information, refer to the [custom fields development section](../../develop/howtos/custom_fields.md) in the documentation.
+You can also extend the default components or implement your owns. To get more information, refer to the [custom fields development section](../../howtos/custom_fields.md) in the documentation.
 
 #### Fields in the upload form
 

diff --git a/docs/releases/versions/version-v11.0.0.md b/docs/releases/versions/version-v11.0.0.md
@@ -40,7 +40,7 @@ You can try this feature out by changing the configuration variable `COMMUNITIES
 With InvenioRDM v11, you can now add your own custom code and views directly to your instance,
 without creating extra modules and adding them to the list of dependencies.
 
-Discover how by reading the dedicated [How-to](../../develop/howtos/custom_code.md).
+Discover how by reading the dedicated [How-to](../../howtos/custom_code.md).
 
 ### Override landing page template
 
@@ -57,13 +57,13 @@ You can read more on how to customize template in the [dedicated guide](../../cu
 InvenioRDM now includes a redirector module. It allows an instance to define a mapping of URLs to redirect via a configuration variable.
 This is particularly useful when migrating from an old instance to InvenioRDM.
 
-See instructions on how to configure URL redirection in its [How-to](../../develop/howtos/route_migration.md).
+See instructions on how to configure URL redirection in its [How-to](../../howtos/route_migration.md).
 
 ### Search query parser
 
 Search fields and parameters may change overtime. You can now map legacy search terms into newer terms.
 
-See instruction on how to add search terms mappings in its [How-to](../../develop/howtos/search_terms_migration.md).
+See instruction on how to add search terms mappings in its [How-to](../../howtos/search_terms_migration.md).
 
 ### User visibility
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -109,18 +109,6 @@ nav:
           - Sanitize input data: develop/topics/validation.md
           - Theming: develop/topics/theming.md
           - Administration panel: develop/topics/administration_panel.md
-      - How-to guides:
-          - Translation (i18n): develop/howtos/i18n.md
-          - Create a new custom field: develop/howtos/custom_fields.md
-          - Create custom code and views: develop/howtos/custom_code.md
-          - Add JavaScript: "develop/howtos/add_javascript.md"
-          - Override UI React components: develop/howtos/override_components.md
-          - Create search terms mappings: develop/howtos/search_terms_migration.md
-          - Create a database migration: develop/howtos/alembic.md
-          - Fix a vulnerability: develop/howtos/security-fix.md
-          - Test emails locally: develop/howtos/dev_email.md
-          - Migrate legacy routes: develop/howtos/route_migration.md
-          - Back up search indices: develop/howtos/backup_search_indices.md
       - Architecture:
           - Introduction: develop/architecture/index.md
           - Infrastructure: develop/architecture/infrastructure.md
@@ -135,6 +123,23 @@ nav:
           - Optimistic concurrency control: develop/concepts/concurrency-control.md
           - Database transaction management: develop/concepts/transactions.md
   - Deploy: deploy/index.md
+  - How-tos:
+      - How Tos: "howtos/index.md"
+      - Administration:
+          - Setup: "howtos/administration/index.md"
+          - Interface: "howtos/administration/interface.md"
+      - Development:
+          - Translation (i18n): howtos/i18n.md
+          - Create a new custom field: howtos/custom_fields.md
+          - Create custom code and views: howtos/custom_code.md
+          - Add JavaScript: "howtos/add_javascript.md"
+          - Override UI React components: howtos/override_components.md
+          - Create search terms mappings: howtos/search_terms_migration.md
+          - Create a database migration: howtos/alembic.md
+          - Fix a vulnerability: howtos/security-fix.md
+          - Test emails locally: howtos/dev_email.md
+          - Migrate legacy routes: howtos/route_migration.md
+          - Back up search indices: howtos/backup_search_indices.md
   - Reference:
       - Overview: reference/index.md
       - CLI: reference/cli.md