Skip to content

Commit

Permalink
5.2.4-administration-manual (#84)
Browse files Browse the repository at this point in the history
* Update to 5.2.4

* Create search-settings.md

* adds administration search settings images

also adds new administration control panel and dashboard button images that can be shared between other pages

* Adds images and manual to get to search features

* Rename admin-dashboard-search.jpg to admin-dashboard-search-settings.jpg

* Adds search reindex button information

* Adds search reindex button image

* Adds Search Settings TOC

* fix image link for reindex

* Update search-settings.md

* Create url-management.md

* Create language-management.md

* Adds Administrator Dashboard Images

* Create visitor-management.md

* Update toc.yml to add missing pages

* Create access-control-panel.md

to be shared between admin, host and other places that can use this same information, so we can update it in one place in the future if needed.

* Update and rename access-control-panel.md to access-admin-dashboard.md

* Delete src/pages/manuals/admin/access-admin-dashboard.md

* Adds urls mapped images

* Update and rename url-management.md to url-mappings.md

* Add files via upload

* Update url-mappings.md

* Add files via upload

* Update url-mappings.md

* Update url-mappings.md

* Update visitor-management.md

* Update visitor-management.md

* Update visitor-management.md

* Update visitor-management.md

* Add Visitor Management Images

* Update language-management.md

* Adds Language Management Images

* Update language-management.md

* Add files via upload

* Update language-management.md

* Update language-management.md

* Adds language management search image

* Update language-management.md

* Update language-management.md

* Update User Manuals toc.yml

* Rename event-log.md to event-log.md

* Rename index.md to index.md

* Rename module-management.md to module-management.md

* Rename theme-management.png to theme-management.png

* Delete src/pages/manuals/admin/host-administration/assets directory

* Rename scheduled-jobs.md to scheduled-jobs.md

* Rename site-management.md to site-management.md

* Rename event-log.md to event-log.md

* Rename sql-management.md to sql-management.md

* Rename system-info.md to system-info.md

* Rename event-log.md to event-log.md

* Rename system-update.md to system-update.md

* Rename theme-management.md to theme-management.md

* Rename toc.yml to toc.yml

* Rename src/pages/manuals/admin/control-panel/assets/page-management.png to src/pages/manuals/admin/content-management/page-management.png

* Rename content-editor.md to content-editor.md

* Rename page-management.md to page-management.md

* Rename src/pages/manuals/admin/content-management/page-management.png to src/pages/manuals/admin/content-management/assets/page-management.png

* Rename index.md to index.md

* Rename toc.yml to toc.yml

* Rename modules.md to modules.md

* Delete src/pages/manuals/admin/control-panel directory

* Rename file-management.md to file-management.md

* Rename visitor-management.png to visitor-management.png

* Rename visitor-management.md to visitor-management.md

* Rename user-management.md to user-management.md

* Rename index.md to index.md

* Rename language-management.md to language-management.md

* Rename page-management.md to page-management.md

* Rename toc.yml to toc.yml

* Rename url-mappings.md to url-mappings.md

* Rename site-settings.md to site-settings.md

* Rename search-settings.md to search-settings.md

* Rename role-management.md to role-management.md

* Rename profile-management.md to profile-management.md

* Rename recycle-bin.md to recycle-bin.md

* Rename add-page.png to add-page.png

* Rename add-profile.png to add-profile.png

* Rename admin-dash.png to admin-dash.png

* Rename admin-dashboard-file-management.jpg to admin-dashboard-file-management.jpg

* Rename admin-dashboard-language-management.jpg to admin-dashboard-language-management.jpg

* Rename admin-dashboard-page-management.jpg to admin-dashboard-page-management.jpg

* Rename admin-dashboard-profile-management.jpg to admin-dashboard-profile-management.jpg

* Rename admin-dashboard-recycle-bin.jpg to admin-dashboard-recycle-bin.jpg

* Rename admin-dashboard-recycle-bin.jpg to admin-dashboard-recycle-bin.jpg

* Rename admin-dashboard-role-management.jpg to admin-dashboard-role-management.jpg

* Rename admin-dashboard-search-settings.jpg to admin-dashboard-search-settings.jpg

* Rename admin-dashboard-site-settings.jpg to admin-dashboard-site-settings.jpg

* Rename admin-dashboard-url-mappings.jpg to admin-dashboard-url-mappings.jpg

* Rename admin-dashboard-user-management.jpg to admin-dashboard-user-management.jpg

* Rename admin-dashboard-visitor-management.jpg to admin-dashboard-visitor-management.jpg

* Rename visitor-management-visitors-tab.png to visitor-management-visitors-tab.png

* Rename control-panel-admin-dashboard-button.jpg to control-panel-admin-dashboard-button.jpg

* Rename control-panel-button.jpg to control-panel-button.jpg

* Rename edit-profile.png to edit-profile.png

* Rename file-management.png to file-management.png

* Rename language-management-add-language-settings.png to language-management-add-language-settings.png

* Rename language-management-add-language.png to language-management-add-language.png

* Rename language-management-edit-delete-buttons.png to language-management-edit-delete-buttons.png

* Rename language-management-edit-settings.png to language-management-edit-settings.png

* Rename language-management-list.png to language-management-list.png

* Rename language-management-search.png to language-management-search.png

* Rename language-management.png to language-management.png

* Rename navigation-search.jpg to navigation-search.jpg

* Rename page-appearance.png to page-appearance.png

* Rename page-management.png to page-management.png

* Rename permissions.png to permissions.png

* Rename visitor-management-settings-tab.png to visitor-management-settings-tab.png

* Rename visitor-management-details.png to visitor-management-details.png

* Rename user-profile.png to user-profile.png

* Delete src/pages/manuals/admin/admin-management/assets/visitor-management-details.png

* Add files via upload

* Rename search-settings-administration.jpg to admin-search-settings-administration.jpg

* Rename profile-management.png to profile-management.png

* Delete src/pages/manuals/admin/admin-dashboard/assets/url-mappings-broken-urls.jpg

* Rename pwa-settings.png to admin-pwa-settings.png

* Rename admin-pwa-settings.png to admin-pwa-settings.png

* Delete src/pages/manuals/admin/admin-dashboard/assets/url-mappings-mapped-urls.jpg

* Rename url-mappings.png to url-mappings.png

* Rename recycle-bin.png to recycle-bin.png

* Rename search-reindex-button.jpg to search-reindex-button.jpg

* Rename user-management.png to user-management.png

* Rename site-settings-1.png to site-settings-1.png

* Rename site-settings-2.png to site-settings-2.png

* Rename smtp-settings.png to smtp-settings.png

* Rename url-mappings-add-url.png to url-mappings-add-url.png

* Rename url-mappings-broken-urls.png to url-mappings-broken-urls.png

* Rename url-mappings-edit-broken-urls.png to url-mappings-edit-broken-urls.png

* Rename url-mappings-edit-mapped-urls.png to url-mappings-edit-mapped-urls.png

* Rename url-mappings-mapped-urls.png to url-mappings-mapped-urls.png

* Rename url-mappings-settings.png to url-mappings-settings.png

* Rename user-identity.png to user-identity.png

* Rename index.md to control-panel.md

* Rename content-arrow.png to content-arrow.png

* Delete src/pages/manuals/admin/site-administration/assets directory

* Update toc.yml

* Update and rename modules.md to module-management.md

* Update control-panel.md

* Update toc.yml

* Update toc.yml

* Update index.md

* Update index.md

* Update index.md

* Update toc.yml

* Update toc.yml

* Update index.md

* Adds Admin Management For Oqtane 5.2.4 Images

* Adds Host Management Images For Oqtane 5.2.4

* Adds Content Management Images For Oqtane 5.2.4

* Rename site-setings-ui-component-settings-render-mode.png to site-settings-ui-component-settings-render-mode.png

* Rename site-setings-ui-component-settings-interactivity.png to site-settings-ui-component-settings-interactivity.png

* Adds 5.2.4 Host Management Image Assets

* Create Installation Guide index.md

* Create installation guilde toc.yml

* Create index.md

* Create Modules toc.yml

* Create index.md

* Create toc.yml

* Create Troubleshooting Guides index.md

* Create toc.yml

* Update Guides toc.yml

- adds installation, modules, troubleshooting and marketplace

* Update troubleshooting guide index.md

* Update toc.yml

* Create troubleshooting-login-issues.md

* Create troubleshooting-user-registration-email-verification.md

* Update troubleshooting-user-registration-email-verification.md

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update index.md

* Update index.md

* Rename adding-modules.md to adding-modules.md

* Move creating-a-module.md to guides/modules

* Move to modules guides

* Fix Move creating-a-module.md

* Rename src/pages/manuals/admin/modules/customizing-module-appearance.md to src/pages/guides/modules/customizing-module-appearance.md

* Rename src/pages/manuals/admin/modules/module-configuration.md to src/pages/guides/modules/module-configuration.md

* Move working-with-modules.md to to content management

* Rename src/pages/manuals/admin/modules/module-deployment.md to src/pages/guides/modules/module-deployment.md

* Rename module-configuration.md to module-configuration.md

* Rename src/pages/manuals/content-management/module-configuration.md to src/pages/manuals/admin/content-management/module-configuration.md

* Rename src/pages/manuals/admin/modules/module-development.md to src/pages/guides/modules/module-development.md

* Rename src/pages/manuals/admin/modules/module-installation.md to src/pages/guides/modules/module-installation.md

* Rename src/pages/manuals/admin/modules/troubleshooting.md to src/pages/guides/troubleshooting/troubleshooting-modules.md

* Rename index.md to modules.md

* Delete src/pages/manuals/admin/modules directory

* Rename src/pages/manuals/admin/themes/theme-configuration.md to src/pages/guides/theme/theme-configuration.md

* Rename theme-configuration.md to theme-configuration.md

* Rename src/pages/manuals/admin/themes/theme-development.md to src/pages/guides/themes/theme-development.md

* Rename src/pages/manuals/admin/themes/theme-installation.md to src/pages/guides/themes/theme-installation.md

* Rename src/pages/manuals/admin/themes/theme-management.md to src/pages/guides/themes/theme-management.md

* Rename src/pages/manuals/admin/themes/troubleshooting.md to src/pages/guides/themes/troubleshooting.md

* Rename src/pages/manuals/admin/themes/index.md to src/pages/guides/themes/index-old.md

* Rename src/pages/manuals/admin/themes/toc.yml to src/pages/guides/themes/toc-old.yml

* Rename troubleshooting.md to troubleshooting-themes.md

* Update index.md

* Update index.md

* Update and rename src/pages/manuals/admin/marketplace/index.md to src/pages/guides/marketplace/index1.md

* Delete src/pages/guides/marketplace/index.md

* Rename index1.md to index.md

* Rename monetization.md to monetization.md

* Rename src/pages/manuals/guides/marketplace/monetization.md to src/pages/guides/marketplace/monetization.md

* Rename src/pages/manuals/admin/marketplace/using-oqtane-marketplace.md to src/pages/guides/marketplace/using-oqtane-marketplace.md

* Rename src/pages/manuals/admin/marketplace/submitting-contributions.md to src/pages/guides/marketplace/submitting-contributions.md

* Rename src/pages/manuals/admin/marketplace/troubleshooting.md to src/pages/guides/troubleshooting/troubleshooting-marketplace.md

* Update toc.yml

* Rename src/pages/manuals/admin/installation/troubleshooting.md to src/pages/guides/troubleshooting/troubleshooting-installations.md

* Rename src/pages/manuals/admin/themes/assets/placeholder.md to src/pages/guides/themes/assets/placeholder.md

* Rename src/pages/manuals/admin/content-management/modules.md to src/pages/guides/modules/modules.md

* Update page-management.md

* Update page-management.md

* Update page-management.md

* Update toc.yml

* apply latest commits

* Update Manual Installation TOC

* Admin Management Updates

* update user management

* fixes modules guides links and images

* updates modules, themes and troubleshooting guides TOC and add  missing pages

* updates admin management section

* updates host management manuals content
  • Loading branch information
thabaum authored Nov 6, 2024
1 parent 91f9ad3 commit c95e306
Show file tree
Hide file tree
Showing 297 changed files with 1,241 additions and 321 deletions.
File renamed without changes.
98 changes: 97 additions & 1 deletion src/pages/guides/installation/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,97 @@
# Installation Guide
---
uid: Guides.Installation.Index
---

# Installation

Oqtane is a modular application framework that allows you to create
dynamic web sites and applications using Blazor and .NET MAUI.
Oqtane supports various deployment scenarios and databases.
This section provides installation instructions for different environments and configurations.

## Download an Official Release

Find the official Oqtane releases on GitHub and follow these steps to download:

1. Visit the [Official Oqtane Releases page on GitHub](https://github.com/oqtane/oqtane.framework/releases).
2. Browse the list of releases to find the version you need.
3. Click on the release to view its details.
4. Download the release package by clicking on the appropriate link.

## Reset an Existing Oqtane Installation

If you need to perform a clean database install for a previous version of Oqtane, follow these steps:

1. Open the `Oqtane.Server\appsettings.json` file.
2. Locate the `DefaultConnection` value and set it to `""`.
3. Run the application to trigger the re-installation process, which will execute the database installation scripts.

---

## Upgrade

Learn how to upgrade your existing Oqtane installation manually or through an automated process:

- [Upgrading Oqtane](upgrade.md): This section provides information on how to upgrade your existing Oqtane installation manually or through an automated process.

---

## Development

This section provides installation instructions for development purposes.
You can choose between Windows or Linux development environments
and use Visual Studio or Visual Studio Code as your IDE.

### Windows

- [Windows Visual Studio Development](development.md): Install Oqtane quickly for development, primarily for Visual Studio and Windows development.
- [Windows Visual Studio Code Development](development-vs-code.md): Install Oqtane quickly for development, primarily for Visual Studio Code and Windows development.

### Linux

- [Linux Visual Studio Code Development](development-vs-code-linux.md): Install Oqtane quickly for development, primarily for Visual Studio Code and Linux development.

---

## Deploy

This section provides installation instructions for deploying Oqtane to various environments using a release package.
You will learn how to install the prerequisites, create a database, and configure the web server for your Oqtane application.

You can choose between the following deployment options:

### Azure

Install Oqtane using the Deploy to Azure feature:

- [Deploy Oqtane To Azure](deploy-to-azure.md): This guide shows you how to install Oqtane using the above Deploy To Azure feature.

### Windows IIS

Install Oqtane with various configurations on Windows using IIS:

- [Install Oqtane with IIS Express and SQL Express](windows-iis-express-sql-express.md): This guide shows you how to install Oqtane on Windows using IIS Express and SQL Express Server.
- [Install Oqtane with IIS Express and LocalDB](windows-iis-localdb.md): This guide shows you how to install Oqtane on Windows using IIS (Express) and LocalDb.
- [Install Oqtane with IIS and SQL Server](windows-iis-sql.md): This guide shows you how to install Oqtane on Windows using IIS and SQL Server.

### Linux Apache

Install Oqtane with Apache on Linux (Ubuntu) with MySQL or PostgreSQL:

- [Install Oqtane with Apache and MySQL](linux-ubuntu-apache-mysql.md): This guide shows you how to install Oqtane on Linux using Apache and MySQL.
- [Install Oqtane with Apache and PostgreSQL](linux-ubuntu-apache-postgresql.md): This guide shows you how to install Oqtane on Linux using Apache and PostgreSQL.

---

## Resources

Explore additional installation resources and access the Oqtane blog and GitHub repository:

- [Oqtane Installation Troubleshooting Tips](troubleshooting.md): If you encounter issues during the installation, upgrade, development, or deployment process, you can refer to our troubleshooting tips.
- [Oqtane Supported Databases](databases.md): Find detailed information on all databases supported by Oqtane for both Windows and Linux.
- [Oqtane Installation Resources](resources.md): Access comprehensive installation guides and resources for deploying Oqtane on various platforms.
- [Oqtane Blog](https://www.oqtane.org/blog): Stay updated with the latest news, announcements, and insights from the Oqtane community by exploring the Oqtane blog.
- [Oqtane GitHub Repository](https://github.com/oqtane/oqtane.framework): Access the Oqtane framework's GitHub repository to explore the source code, contribute to development, and stay informed about the latest updates and releases.

[← Back to Documentation Guides Home Page](../index.md)

File renamed without changes.
File renamed without changes.
40 changes: 39 additions & 1 deletion src/pages/guides/installation/toc.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
- name: Overview
href: index.md

- name: TODO @CODY
- name: Development Getting Started
- name: Visual Studio, IIS Express, SQL Express LocalDb
href: ./development.md
- name: VS Code, IIS Express, SQL Express LocalDb
href: ./development-vs-code.md
- name: VS Code (Linux), Apache, MySQL
href: ./development-vs-code-linux.md

- name: Azure Deployment
- name: Deploy To Azure
href: ./deploy-to-azure.md

- name: Windows Deployment
- name: Windows, IIS, LocalDb
href: ./windows-iis-localdb.md
- name: Windows, IIS Express, SQL Express
href: ./windows-iis-express-sql-express.md
- name: Windows, IIS, SQL
href: ./windows-iis-sql.md

- name: Linux Deployment
- name: Linux (Ubuntu), Apache, MySQL
href: ./linux-ubuntu-apache-mysql.md
- name: Linux (Ubuntu), Apache, PostgreSQL
href: ./linux-ubuntu-apache-postgresql.md

- name: Additional Information
- name: Upgrading Oqtane
href: ./upgrade.md
- name: Oqtane.Maui App Setup
href: ./maui-setup.md
- name: Supported Databases
href: ./databases.md
- name: Installation Resources
href: ./resources.md
- name: Installation Troubleshooting
href: ./troubleshooting.md
Empty file.
File renamed without changes.
34 changes: 24 additions & 10 deletions src/pages/guides/marketplace/toc.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
- name: Using the Oqtane Marketplace
href: using-oqtane-marketplace.md

- name: Installing Modules
# href: installing-modules.md

# TODO
- name: TODO @CODY
topicHref: index.md
<<<<<<< Updated upstream
- name: Using the Oqtane Marketplace
href: using-oqtane-marketplace.md

- name: Installing Modules
# href: installing-modules.md

=======
>>>>>>> Stashed changes
- name: Submitting Themes and Modules
# href: submitting-themes-modules.md

- name: Monetization
topicHref: monetization.md

- name: Submitting a Module
topicHref: submitting-contribution.md

- name: Using TODO
topicHref: using-oqtane-marketplace.md
href: ./monetization.md

- name: Troubleshooting
<<<<<<< Updated upstream
href: troubleshooting.md
=======
href: troubleshooting.md
>>>>>>> Stashed changes
Empty file.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adding Modules to a Page

In order to add a module to a page, simply open the control panel with the gear icon in the top right of a page and in the [module management feature](../control-panel/modules.md) there is the ability to select a new module from the options of:
In order to add a module to a page, simply open the control panel with the gear icon in the top right of a page and in the [control panel module management feature](../../manuals/admin/content-management/control-panel.md) there is the ability to select a new module from the options of:

* Admin Module: These are only available to people within the administrator role and there are many more default modules available to put onto your webpages.
* Common Module: These are available both to administrators and to registered users to be able to use on pages that are specified as personalizable, meaning users can modify them as they see fit and they are unique and only viewable to registered users.
Expand All @@ -9,11 +9,9 @@ In order to add a module to a page, simply open the control panel with the gear
There are also features after selecting the module that you would like which are the:

* Title: Which is what will be displayed directly above the module as its title, if nothing is selected then the module's name will be put as the title.
* Pane: Select which content pane you want the module to go inside of. Panes are made visible with the [content editor](../site-administration/content-editor.md).
* Pane: Select which content pane you want the module to go inside of. Panes are made visible with the [content editor](../../manuals/admin/content-management/content-editor.md).
* Container: Select if you would like to have a title displayed above the module or not have one.

![adding-modules](./assets/adding-modules.png)

### Adding One Module Across Multiple Pages

As noted earlier, modules are reusable pieces of functionality, and as such a single module can be inserted across multiple pages in a site. Say, for example, you have an HTML module that holds a banner image and you want that banner image to also exist on five specific pages in your site. Instead of adding a new module to all five of those pages and then inserting the same image, you can simply go into the Control Panel and then click Add an Existing Module to the page. Adding already existing modules or sharing modules across multiple pages makes managing content that's repeated much more efficient. A content manager can then make edits in one module and instantly have those edits reflected across every page on which the module is shared.
Expand Down
Empty file.
36 changes: 35 additions & 1 deletion src/pages/guides/modules/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# Module Development Guides
# Modules Overview

Welcome to the Modules section of the Oqtane documentation. Here you'll find detailed guides on working with modules in your Oqtane-based applications. Whether you're adding new functionality, configuring existing modules, or troubleshooting issues, this section provides comprehensive resources to assist you.

## What is a Module?

A module is a reusable, plug-and-play piece of functionality. It's a way to extend the functionality of the framework with whatever functionality you desire. Examples of modules could be photo galleries, blogs, rotators, forms, and so on. There can be multiple modules on a page and even multiple instances of the same module on a page. It's very common to see multiple HTML modules on a single page.
When you install Oqtane, the platform ships with a base set of modules already installed in the system. There are too many that come with the solution out of the box to list here, but suffice it to say that all modules needed for basic functionality within a website come with the solution. More modules can also be downloaded for use or modules that you can created can be uploaded.

## Modules on Pages

Modules are placed onto pages in locations called “panes”. These panes are defined by the theme's designer. These themes dictates the overall look and feel of your site and is usually created by a front-end designer. Panes can span the full width of the page or be positioned in a column fashion. It may be helpful to think of panes as windows in the design of the site where you can drop in modules. You can move modules around the panes by using the [content editor](../content-management/content-editor.md).

This is an example of a content pane.

![content-pane](../../manuals/admin/content-management/assets/content-editor-pane-border.png)

## Topics

### Working With Modules
- [Adding Modules](adding-modules.md): Learn how to add new modules to your Oqtane site to extend its functionality.
- [Working With Modules](working-with-modules.md): Explore various tasks and operations related to managing installed modules on your site.
- [Installing Modules](module-installation.md): Step-by-step instructions for installing modules on your Oqtane site.
- [Configurating Modules](module-configuration.md): Customize and configure module settings to suit your specific requirements.
- [Customizing Module Appearance](customizing-module-appearance.md): Customize a modules appearance.
- [Troubleshooting Modules](../troubleshooting-working-with-modules.md): Troubleshooting tips and solutions for common issues encountered working with modules.

### Developing Modules
- [Creating Modules](creating-a-module.md): Resources and guidelines for creating custom modules for Oqtane.
- [Developing Modules](module-development.md): Resources and guidelines for developing custom modules for Oqtane.
- [Module Deployment](module-deployment.md): Resources and guidelines for deploying custom modules for Oqtane.
- [Troubleshooting Module Development](troubleshooting-working-with-modules.md): Troubleshooting tips and solutions for common issues encountered with developing modules.


Feel free to explore each topic to find the information you need to effectively work with modules in your Oqtane applications.
9 changes: 3 additions & 6 deletions src/pages/guides/modules/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,21 @@ Welcome to the Modules section of the Oqtane documentation. Here you'll find det
A module is a reusable, plug-and-play piece of functionality. It's a way to extend the functionality of the framework with whatever functionality you desire. Examples of modules could be photo galleries, blogs, rotators, forms, and so on. There can be multiple modules on a page and even multiple instances of the same module on a page. It's very common to see multiple HTML modules on a single page.
When you install Oqtane, the platform ships with a base set of modules already installed in the system. There are too many that come with the solution out of the box to list here, but suffice it to say that all modules needed for basic functionality within a website come with the solution. More modules can also be downloaded for use or modules that you can created can be uploaded.

![installing-modules](./assets/installing-modules.png)
![installing-modules-2](./assets/installing-modules-2.png)

## Modules on Pages

Modules are placed onto pages in locations called “panes”. These panes are defined by the theme's designer. These themes dictates the overall look and feel of your site and is usually created by a front-end designer. Panes can span the full width of the page or be positioned in a column fashion. It may be helpful to think of panes as windows in the design of the site where you can drop in modules. You can move modules around the panes by using the [content editor](../site-administration/content-editor.md).
Modules are placed onto pages in locations called “panes”. These panes are defined by the theme's designer. These themes dictates the overall look and feel of your site and is usually created by a front-end designer. Panes can span the full width of the page or be positioned in a column fashion. It may be helpful to think of panes as windows in the design of the site where you can drop in modules. You can move modules around the panes by using the [content editor](../../manuals/admin/content-management/content-editor.md).

This is an example of a content pane.

![content-pane](./assets/content-pane.png)
![content-pane](../../manuals/admin/content-management/assets/content-editor-pane.png)

## Topics

- [Adding Modules](adding-modules.md): Learn how to add new modules to your Oqtane site to extend its functionality.
- [Working With Modules](working-with-modules.md): Explore various tasks and operations related to managing installed modules on your site.
- [Installing Modules](module-installation.md): Step-by-step instructions for installing modules on your Oqtane site.
- [Configurating Modules](module-configuration.md): Customize and configure module settings to suit your specific requirements.
- [Troubleshooting Modules](troubleshooting.md): Troubleshooting tips and solutions for common issues encountered with modules.
- [Troubleshooting Modules](troubleshooting-working-with-modules.md): Troubleshooting tips and solutions for common issues encountered with modules.
- [Developing Modules](module-development.md): Resources and guidelines for developing custom modules for Oqtane.

Feel free to explore each topic to find the information you need to effectively work with modules in your Oqtane applications.
35 changes: 33 additions & 2 deletions src/pages/guides/modules/toc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
- name: Overview
href: index.md

# TODO
- name: TODO @CODY
<<<<<<< Updated upstream
- name: Overview
href: index.md

=======
>>>>>>> Stashed changes
- name: Working with Modules
items:
- name: Adding Modules
href: adding-modules.md
- name: Working With Modules
href: working-with-modules.md
- name: Installing Modules
href: module-installation.md
- name: Configuring Modules
href: module-configuration.md
- name: Customizing Module Appearance
href: customizing-module-appearance.md
- name: Troubleshooting Modules
href: troubleshooting-modules.md

- name: Developing Modules
items:
- name: Creating Modules
href: creating-a-module.md
- name: Developing Modules
href: module-development.md
- name: Module Deployment
href: module-deployment.md
- name: Troubleshooting Module Development
href: troubleshooting-module-development.md
3 changes: 3 additions & 0 deletions src/pages/guides/modules/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Troubleshoot Working With Modules

Visit [Troubleshooting Modules](../troubleshooting//troubleshooting-modules.md) for resourceful troubleshooting guides.
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Working With Modules
# Working With Modules Overview

In order to access a module's settings, you must be in the content editor. To get into the editor, simply click over the pencil icon top-right corner of the page. This puts you into the edit mode where you will see small white arrows in the top-right corner of every module on the page. These small arrows at the top left corners of each module allow you to move the module on the page, access the module's settings, edit the module, delete the module, and access any specific functionality related to the module.

![pencil](./assets/pencil.png)
![Content Editor Pencil Button](../../manuals/admin/content-management/assets/content-editor-button.png)

Once in Edit mode you will notice that Oqtane uses a very user-friendly and intuitive approach to managing content. Whenever you want to edit content in Oqtane, you go to the location where the content resides and edit it right there in place.

### Moving Modules

Once a module is on the page, you can move its location again if needed. All that is needed is to enter the [content editor](../site-administration/content-editor.md) by clicking on the pencil icon in the top right hand side with editing permission on a certain page. And then selecting the small downward pointing arrow in the top left of the module to do a variety of things to it, including:
Once a module is on the page, you can move its location again if needed. All that is needed is to enter the [content editor](../../manuals/admin/content-management/content-editor.md) by clicking on the pencil icon in the top right hand side with editing permission on a certain page. And then selecting the small downward pointing arrow in the top left of the module to do a variety of things to it, including:
* Move to Top: Moves the modules to the top of the page to be the first module displayed.
* Move Up: Moves the module up to be above the module above it.
* Move Down: Move the module down below the module beneath it.
Expand All @@ -19,5 +19,3 @@ If the page has the layout for multiple panes, which will allows for three cente
* Move to Right Pane: Moves the module to the right-most column.
* Move to Content Pane: Moves the module to the central column.
* Move to Bottom Pane: Moves the module to the pane at the bottom of the page.

![moving-menu](./assets/moving-menu.png)
Loading

0 comments on commit c95e306

Please sign in to comment.