diff --git a/src/pages/manuals/admin/installation/_windows-iis-secure.md b/src/pages/guides/installation/_windows-iis-secure.md similarity index 100% rename from src/pages/manuals/admin/installation/_windows-iis-secure.md rename to src/pages/guides/installation/_windows-iis-secure.md diff --git a/src/pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png b/src/pages/guides/installation/assets/admin-dashboard-site-settings.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png rename to src/pages/guides/installation/assets/admin-dashboard-site-settings.png diff --git a/src/pages/manuals/admin/installation/assets/apache-http-server-logo.png b/src/pages/guides/installation/assets/apache-http-server-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/apache-http-server-logo.png rename to src/pages/guides/installation/assets/apache-http-server-logo.png diff --git a/src/pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png b/src/pages/guides/installation/assets/control-panel-admin-dashboard.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png rename to src/pages/guides/installation/assets/control-panel-admin-dashboard.png diff --git a/src/pages/manuals/admin/installation/assets/linux-logo.png b/src/pages/guides/installation/assets/linux-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/linux-logo.png rename to src/pages/guides/installation/assets/linux-logo.png diff --git a/src/pages/manuals/admin/installation/assets/maui-run-windows-machine.png b/src/pages/guides/installation/assets/maui-run-windows-machine.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/maui-run-windows-machine.png rename to src/pages/guides/installation/assets/maui-run-windows-machine.png diff --git a/src/pages/manuals/admin/installation/assets/maui-set-local-development-url.png b/src/pages/guides/installation/assets/maui-set-local-development-url.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/maui-set-local-development-url.png rename to src/pages/guides/installation/assets/maui-set-local-development-url.png diff --git a/src/pages/manuals/admin/installation/assets/maui-set-url.png b/src/pages/guides/installation/assets/maui-set-url.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/maui-set-url.png rename to src/pages/guides/installation/assets/maui-set-url.png diff --git a/src/pages/manuals/admin/installation/assets/maui-solution.png b/src/pages/guides/installation/assets/maui-solution.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/maui-solution.png rename to src/pages/guides/installation/assets/maui-solution.png diff --git a/src/pages/manuals/admin/installation/assets/microsoft-azure-logo.png b/src/pages/guides/installation/assets/microsoft-azure-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/microsoft-azure-logo.png rename to src/pages/guides/installation/assets/microsoft-azure-logo.png diff --git a/src/pages/manuals/admin/installation/assets/microsoft-dot-net-logo.png b/src/pages/guides/installation/assets/microsoft-dot-net-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/microsoft-dot-net-logo.png rename to src/pages/guides/installation/assets/microsoft-dot-net-logo.png diff --git a/src/pages/manuals/admin/installation/assets/microsoft-office-teams-logo.jpg b/src/pages/guides/installation/assets/microsoft-office-teams-logo.jpg similarity index 100% rename from src/pages/manuals/admin/installation/assets/microsoft-office-teams-logo.jpg rename to src/pages/guides/installation/assets/microsoft-office-teams-logo.jpg diff --git a/src/pages/manuals/admin/installation/assets/ms-sql-server-logo.png b/src/pages/guides/installation/assets/ms-sql-server-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/ms-sql-server-logo.png rename to src/pages/guides/installation/assets/ms-sql-server-logo.png diff --git a/src/pages/manuals/admin/installation/assets/mysql-logo.png b/src/pages/guides/installation/assets/mysql-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/mysql-logo.png rename to src/pages/guides/installation/assets/mysql-logo.png diff --git a/src/pages/manuals/admin/installation/assets/oqtane-automated-upgrade-process.png b/src/pages/guides/installation/assets/oqtane-automated-upgrade-process.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/oqtane-automated-upgrade-process.png rename to src/pages/guides/installation/assets/oqtane-automated-upgrade-process.png diff --git a/src/pages/manuals/admin/installation/assets/postgresql-logo.png b/src/pages/guides/installation/assets/postgresql-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/postgresql-logo.png rename to src/pages/guides/installation/assets/postgresql-logo.png diff --git a/src/pages/manuals/admin/installation/assets/red-hat-enterprise-linux-logo.svg.png b/src/pages/guides/installation/assets/red-hat-enterprise-linux-logo.svg.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/red-hat-enterprise-linux-logo.svg.png rename to src/pages/guides/installation/assets/red-hat-enterprise-linux-logo.svg.png diff --git a/src/pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png b/src/pages/guides/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png rename to src/pages/guides/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png diff --git a/src/pages/manuals/admin/installation/assets/sqlite-logo.png b/src/pages/guides/installation/assets/sqlite-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/sqlite-logo.png rename to src/pages/guides/installation/assets/sqlite-logo.png diff --git a/src/pages/manuals/admin/installation/assets/ubuntu-logo-2022.png b/src/pages/guides/installation/assets/ubuntu-logo-2022.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/ubuntu-logo-2022.png rename to src/pages/guides/installation/assets/ubuntu-logo-2022.png diff --git a/src/pages/manuals/admin/installation/assets/ubuntu-logo.png b/src/pages/guides/installation/assets/ubuntu-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/ubuntu-logo.png rename to src/pages/guides/installation/assets/ubuntu-logo.png diff --git a/src/pages/manuals/admin/installation/assets/user-management-token-settings.png b/src/pages/guides/installation/assets/user-management-token-settings.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/user-management-token-settings.png rename to src/pages/guides/installation/assets/user-management-token-settings.png diff --git a/src/pages/manuals/admin/installation/assets/visual-studio-logo.jpg b/src/pages/guides/installation/assets/visual-studio-logo.jpg similarity index 100% rename from src/pages/manuals/admin/installation/assets/visual-studio-logo.jpg rename to src/pages/guides/installation/assets/visual-studio-logo.jpg diff --git a/src/pages/manuals/admin/installation/assets/visual-studio-logo.png b/src/pages/guides/installation/assets/visual-studio-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/visual-studio-logo.png rename to src/pages/guides/installation/assets/visual-studio-logo.png diff --git a/src/pages/manuals/admin/installation/assets/windows-11-logo.png b/src/pages/guides/installation/assets/windows-11-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/windows-11-logo.png rename to src/pages/guides/installation/assets/windows-11-logo.png diff --git a/src/pages/manuals/admin/installation/assets/windows-logo.png b/src/pages/guides/installation/assets/windows-logo.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/windows-logo.png rename to src/pages/guides/installation/assets/windows-logo.png diff --git a/src/pages/manuals/admin/installation/assets/windows-server-2022-logo.svg.png b/src/pages/guides/installation/assets/windows-server-2022-logo.svg.png similarity index 100% rename from src/pages/manuals/admin/installation/assets/windows-server-2022-logo.svg.png rename to src/pages/guides/installation/assets/windows-server-2022-logo.svg.png diff --git a/src/pages/manuals/admin/installation/databases.md b/src/pages/guides/installation/databases.md similarity index 100% rename from src/pages/manuals/admin/installation/databases.md rename to src/pages/guides/installation/databases.md diff --git a/src/pages/manuals/admin/installation/deploy-to-azure.md b/src/pages/guides/installation/deploy-to-azure.md similarity index 100% rename from src/pages/manuals/admin/installation/deploy-to-azure.md rename to src/pages/guides/installation/deploy-to-azure.md diff --git a/src/pages/manuals/admin/installation/development-vs-code-linux.md b/src/pages/guides/installation/development-vs-code-linux.md similarity index 100% rename from src/pages/manuals/admin/installation/development-vs-code-linux.md rename to src/pages/guides/installation/development-vs-code-linux.md diff --git a/src/pages/manuals/admin/installation/development-vs-code.md b/src/pages/guides/installation/development-vs-code.md similarity index 100% rename from src/pages/manuals/admin/installation/development-vs-code.md rename to src/pages/guides/installation/development-vs-code.md diff --git a/src/pages/manuals/admin/installation/development.md b/src/pages/guides/installation/development.md similarity index 100% rename from src/pages/manuals/admin/installation/development.md rename to src/pages/guides/installation/development.md diff --git a/src/pages/guides/installation/index.md b/src/pages/guides/installation/index.md index 96025dd9b..150d7b298 100644 --- a/src/pages/guides/installation/index.md +++ b/src/pages/guides/installation/index.md @@ -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) + diff --git a/src/pages/manuals/admin/installation/linux-ubuntu-apache-mysql.md b/src/pages/guides/installation/linux-ubuntu-apache-mysql.md similarity index 100% rename from src/pages/manuals/admin/installation/linux-ubuntu-apache-mysql.md rename to src/pages/guides/installation/linux-ubuntu-apache-mysql.md diff --git a/src/pages/manuals/admin/installation/linux-ubuntu-apache-postgresql.md b/src/pages/guides/installation/linux-ubuntu-apache-postgresql.md similarity index 100% rename from src/pages/manuals/admin/installation/linux-ubuntu-apache-postgresql.md rename to src/pages/guides/installation/linux-ubuntu-apache-postgresql.md diff --git a/src/pages/manuals/admin/installation/maui-setup.md b/src/pages/guides/installation/maui-setup.md similarity index 100% rename from src/pages/manuals/admin/installation/maui-setup.md rename to src/pages/guides/installation/maui-setup.md diff --git a/src/pages/manuals/admin/installation/resources.md b/src/pages/guides/installation/resources.md similarity index 100% rename from src/pages/manuals/admin/installation/resources.md rename to src/pages/guides/installation/resources.md diff --git a/src/pages/guides/installation/toc.yml b/src/pages/guides/installation/toc.yml index 4da094c79..6f0bf5bd6 100644 --- a/src/pages/guides/installation/toc.yml +++ b/src/pages/guides/installation/toc.yml @@ -1,2 +1,40 @@ +- name: Overview + href: index.md -- name: TODO @CODY \ No newline at end of file +- 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 diff --git a/src/pages/guides/installation/troubleshooting.md b/src/pages/guides/installation/troubleshooting.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/pages/manuals/admin/installation/upgrade.md b/src/pages/guides/installation/upgrade.md similarity index 100% rename from src/pages/manuals/admin/installation/upgrade.md rename to src/pages/guides/installation/upgrade.md diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg b/src/pages/guides/installation/walkthrough-dev/assets/121 Get from Github.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/121 Get from Github.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg b/src/pages/guides/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg b/src/pages/guides/installation/walkthrough-dev/assets/201 Disable HotReload.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/201 Disable HotReload.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg b/src/pages/guides/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg b/src/pages/guides/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg b/src/pages/guides/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg b/src/pages/guides/installation/walkthrough-dev/assets/292 Login as Super User.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/292 Login as Super User.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg b/src/pages/guides/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg b/src/pages/guides/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg b/src/pages/guides/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg b/src/pages/guides/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg b/src/pages/guides/installation/walkthrough-dev/assets/321 Install Module Start.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/321 Install Module Start.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg b/src/pages/guides/installation/walkthrough-dev/assets/322 Select Module.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/322 Select Module.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg b/src/pages/guides/installation/walkthrough-dev/assets/323 Accept Module License.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/323 Accept Module License.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg b/src/pages/guides/installation/walkthrough-dev/assets/324 Installed.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/324 Installed.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg b/src/pages/guides/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg b/src/pages/guides/installation/walkthrough-dev/assets/332 Confirm Restart.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/332 Confirm Restart.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg b/src/pages/guides/installation/walkthrough-dev/assets/333 Restarting.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/333 Restarting.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg b/src/pages/guides/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg b/src/pages/guides/installation/walkthrough-dev/assets/341 Add Page.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/341 Add Page.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg b/src/pages/guides/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg b/src/pages/guides/installation/walkthrough-dev/assets/351 Add Content Module.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/351 Add Content Module.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg b/src/pages/guides/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg b/src/pages/guides/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg b/src/pages/guides/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg b/src/pages/guides/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg b/src/pages/guides/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg b/src/pages/guides/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg b/src/pages/guides/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg b/src/pages/guides/installation/walkthrough-dev/assets/411 Add App.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/411 Add App.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg b/src/pages/guides/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg b/src/pages/guides/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg b/src/pages/guides/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg b/src/pages/guides/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg b/src/pages/guides/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg b/src/pages/guides/installation/walkthrough-dev/assets/541 App - Swiper.jpg similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg rename to src/pages/guides/installation/walkthrough-dev/assets/541 App - Swiper.jpg diff --git a/src/pages/manuals/admin/installation/walkthrough-dev/index.md b/src/pages/guides/installation/walkthrough-dev/index.md similarity index 100% rename from src/pages/manuals/admin/installation/walkthrough-dev/index.md rename to src/pages/guides/installation/walkthrough-dev/index.md diff --git a/src/pages/manuals/admin/installation/windows-iis-express-sql-express.md b/src/pages/guides/installation/windows-iis-express-sql-express.md similarity index 100% rename from src/pages/manuals/admin/installation/windows-iis-express-sql-express.md rename to src/pages/guides/installation/windows-iis-express-sql-express.md diff --git a/src/pages/manuals/admin/installation/windows-iis-localdb.md b/src/pages/guides/installation/windows-iis-localdb.md similarity index 100% rename from src/pages/manuals/admin/installation/windows-iis-localdb.md rename to src/pages/guides/installation/windows-iis-localdb.md diff --git a/src/pages/manuals/admin/installation/windows-iis-sql.md b/src/pages/guides/installation/windows-iis-sql.md similarity index 100% rename from src/pages/manuals/admin/installation/windows-iis-sql.md rename to src/pages/guides/installation/windows-iis-sql.md diff --git a/src/pages/manuals/admin/marketplace/assets/placeholder.md b/src/pages/guides/marketplace/assets/placeholder.md similarity index 100% rename from src/pages/manuals/admin/marketplace/assets/placeholder.md rename to src/pages/guides/marketplace/assets/placeholder.md diff --git a/src/pages/guides/marketplace/toc.yml b/src/pages/guides/marketplace/toc.yml index 8c812766c..0f675081f 100644 --- a/src/pages/guides/marketplace/toc.yml +++ b/src/pages/guides/marketplace/toc.yml @@ -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 \ No newline at end of file + href: ./monetization.md + +- name: Troubleshooting +<<<<<<< Updated upstream + href: troubleshooting.md +======= + href: troubleshooting.md +>>>>>>> Stashed changes diff --git a/src/pages/guides/marketplace/troubleshooting.md b/src/pages/guides/marketplace/troubleshooting.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/pages/manuals/admin/content-management/adding-modules.md b/src/pages/guides/modules/adding-modules.md similarity index 87% rename from src/pages/manuals/admin/content-management/adding-modules.md rename to src/pages/guides/modules/adding-modules.md index 1a090fec7..50b67c353 100644 --- a/src/pages/manuals/admin/content-management/adding-modules.md +++ b/src/pages/guides/modules/adding-modules.md @@ -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. @@ -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. diff --git a/src/pages/guides/modules/assets/placeholder.md b/src/pages/guides/modules/assets/placeholder.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/pages/guides/modules/index.md b/src/pages/guides/modules/index.md index ab6c6c6de..2458a15ad 100644 --- a/src/pages/guides/modules/index.md +++ b/src/pages/guides/modules/index.md @@ -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. diff --git a/src/pages/manuals/admin/content-management/module-configuration.md b/src/pages/guides/modules/module-configuration.md similarity index 100% rename from src/pages/manuals/admin/content-management/module-configuration.md rename to src/pages/guides/modules/module-configuration.md diff --git a/src/pages/guides/modules/modules.md b/src/pages/guides/modules/modules.md index ecbe3aa3b..0e2dad741 100644 --- a/src/pages/guides/modules/modules.md +++ b/src/pages/guides/modules/modules.md @@ -7,16 +7,13 @@ 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 @@ -24,7 +21,7 @@ This is an example of a content pane. - [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. diff --git a/src/pages/guides/modules/toc.yml b/src/pages/guides/modules/toc.yml index c633c8769..74fce751a 100644 --- a/src/pages/guides/modules/toc.yml +++ b/src/pages/guides/modules/toc.yml @@ -1,3 +1,34 @@ +- name: Overview + href: index.md -# TODO -- name: TODO @CODY \ No newline at end of file +<<<<<<< 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 \ No newline at end of file diff --git a/src/pages/guides/modules/troubleshooting.md b/src/pages/guides/modules/troubleshooting.md new file mode 100644 index 000000000..19dfb4726 --- /dev/null +++ b/src/pages/guides/modules/troubleshooting.md @@ -0,0 +1,3 @@ +# Troubleshoot Working With Modules + +Visit [Troubleshooting Modules](../troubleshooting//troubleshooting-modules.md) for resourceful troubleshooting guides. \ No newline at end of file diff --git a/src/pages/manuals/admin/content-management/working-with-modules.md b/src/pages/guides/modules/working-with-modules.md similarity index 80% rename from src/pages/manuals/admin/content-management/working-with-modules.md rename to src/pages/guides/modules/working-with-modules.md index 0837e440b..915b8467b 100644 --- a/src/pages/manuals/admin/content-management/working-with-modules.md +++ b/src/pages/guides/modules/working-with-modules.md @@ -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. @@ -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) diff --git a/src/pages/guides/themes/index-old.md b/src/pages/guides/themes/index-old.md deleted file mode 100644 index 530b2bbe2..000000000 --- a/src/pages/guides/themes/index-old.md +++ /dev/null @@ -1,23 +0,0 @@ -## [Overview](index.md) - -Get an overview of the themes section and its contents. - -## [Theme Management](theme-management.md) - -Explore theme management options, including installation, configuration, and troubleshooting. - -### [Installation](theme-installation.md) - -Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience. - -### [Configuration](theme-configuration.md) - -Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements. - -### [Troubleshooting](troubleshooting.md) - -Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems. - -## [Developing Themes](theme-development.md) - -Learn how to develop custom themes for your Oqtane site. diff --git a/src/pages/guides/themes/theme-management.md b/src/pages/guides/themes/theme-management.md deleted file mode 100644 index eb8c43584..000000000 --- a/src/pages/guides/themes/theme-management.md +++ /dev/null @@ -1,13 +0,0 @@ -# Theme Management - -## [Installation](theme-installation.md) - -Learn how to install themes on your Oqtane site to customize its appearance and enhance user experience. - -## [Configuration](theme-configuration.md) - -Explore the various configuration options available for themes in Oqtane and customize their settings to meet your specific requirements. - -## [Troubleshooting](troubleshooting.md) - -Encountering issues with theme installation or configuration? This section provides troubleshooting tips and solutions to common problems. diff --git a/src/pages/guides/themes/toc-old.yml b/src/pages/guides/themes/toc-old.yml deleted file mode 100644 index 86a3983f0..000000000 --- a/src/pages/guides/themes/toc-old.yml +++ /dev/null @@ -1,15 +0,0 @@ -- name: Overview - href: index.md - -- name: Theme Management - href: theme-management.md - items: - - name: Installation - href: theme-installation.md - - name: Configuration - href: theme-configuration.md - - name: Troubleshooting - href: troubleshooting.md - -- name: Developing Themes - href: theme-development.md diff --git a/src/pages/guides/themes/troubleshooting.md b/src/pages/guides/themes/troubleshooting.md new file mode 100644 index 000000000..360067643 --- /dev/null +++ b/src/pages/guides/themes/troubleshooting.md @@ -0,0 +1,26 @@ +# Troubleshooting Themes + +## Overview + +This section provides resources and guidance for troubleshooting various aspects of working with themes in Oqtane. Whether you’re applying pre-built themes or developing custom ones, these guides will help you navigate common issues. + +### Theme Troubleshooting Guides + +Below are two detailed guides for troubleshooting themes, tailored to the specific needs of users and developers: + +- **[Working with Themes](../troubleshooting/troubleshooting-themes.md)** + This guide covers troubleshooting tips and solutions for common issues encountered while using and applying themes in Oqtane. It includes: + - **Theme Activation Issues**: Steps to resolve issues when themes do not apply as expected. + - **Compatibility Checks**: Tips for verifying theme compatibility with your Oqtane version and modules. + - **UI and Styling Errors**: Solutions for fixing display or styling inconsistencies. + - **Permission and Access Problems**: Guidance on ensuring that themes are visible and accessible for all users. + +- **[Developing Themes](../troubleshooting/troubleshooting-themes-development.md)** + This guide provides troubleshooting steps specifically for developers building custom themes in Oqtane. It addresses: + - **Theme Structure and Layout Errors**: Common issues with file structure or layout configuration. + - **CSS and Styling Debugging**: Techniques for diagnosing and fixing styling issues within theme CSS files. + - **JavaScript Errors in Themes**: Identifying and resolving JavaScript errors affecting theme functionality. + - **Localization and Language Support**: Guidance on implementing and troubleshooting multi-language support within themes. + - **Performance Optimization**: Tips for improving theme load times and responsiveness. + +These guides are designed to provide practical solutions and best practices, helping you create or apply themes that function smoothly and look great. \ No newline at end of file diff --git a/src/pages/guides/troubleshooting/assets/placeholder.md b/src/pages/guides/troubleshooting/assets/placeholder.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/pages/guides/troubleshooting/troubleshooting-developing-modules.md b/src/pages/guides/troubleshooting/troubleshooting-developing-modules.md new file mode 100644 index 000000000..c5c6f9a5b --- /dev/null +++ b/src/pages/guides/troubleshooting/troubleshooting-developing-modules.md @@ -0,0 +1,3 @@ +# Troubleshooting Developing Modules + +TODO \ No newline at end of file diff --git a/src/pages/guides/troubleshooting/troubleshooting-developing-themes.md b/src/pages/guides/troubleshooting/troubleshooting-developing-themes.md new file mode 100644 index 000000000..c5c6f9a5b --- /dev/null +++ b/src/pages/guides/troubleshooting/troubleshooting-developing-themes.md @@ -0,0 +1,3 @@ +# Troubleshooting Developing Modules + +TODO \ No newline at end of file diff --git a/src/pages/manuals/admin/admin-management/assets/add-page.png b/src/pages/manuals/admin/admin-management/assets/add-page.png deleted file mode 100644 index d8b1f3ad2..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/add-page.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/add-profile.png b/src/pages/manuals/admin/admin-management/assets/add-profile.png deleted file mode 100644 index 3b0da25a1..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/add-profile.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dash.png b/src/pages/manuals/admin/admin-management/assets/admin-dash.png deleted file mode 100644 index 7d54336b7..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dash.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.jpg deleted file mode 100644 index 2c6485547..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.png new file mode 100644 index 000000000..ac65ffdcc Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-file-management.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.jpg deleted file mode 100644 index cd4aac99f..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.png new file mode 100644 index 000000000..e6e333494 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-language-management.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-new-admin-page.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-new-admin-page.png new file mode 100644 index 000000000..04499fe4d Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-new-admin-page.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.jpg deleted file mode 100644 index 0a30431de..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.png new file mode 100644 index 000000000..cab88f0bf Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-page-management.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.jpg deleted file mode 100644 index f9914d858..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.png new file mode 100644 index 000000000..72e370e12 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-profile-management.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.jpg deleted file mode 100644 index 7e5ab91b4..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.png new file mode 100644 index 000000000..3502b5d5c Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-recycle-bin.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.jpg deleted file mode 100644 index 70d448879..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.png new file mode 100644 index 000000000..1abeb6d41 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-role-management.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.jpg deleted file mode 100644 index 927fd6c13..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.png new file mode 100644 index 000000000..4774bc77b Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search-settings.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search.jpg deleted file mode 100644 index 927fd6c13..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-search.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.jpg deleted file mode 100644 index ecd2a27dd..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.png new file mode 100644 index 000000000..93df39db9 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-site-settings.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.jpg deleted file mode 100644 index 5720069f8..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.png new file mode 100644 index 000000000..a512fe063 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-url-mappings.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.jpg deleted file mode 100644 index 185db3d27..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.png new file mode 100644 index 000000000..85d88d227 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-user-management.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.jpg b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.jpg deleted file mode 100644 index 268705db7..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.png new file mode 100644 index 000000000..cb06d69d2 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard-visitor-management.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-dashboard.png b/src/pages/manuals/admin/admin-management/assets/admin-dashboard.png new file mode 100644 index 000000000..8ac4e3d8e Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/admin-dashboard.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-pwa-settings.png b/src/pages/manuals/admin/admin-management/assets/admin-pwa-settings.png deleted file mode 100644 index 496049a59..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-pwa-settings.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/admin-search-settings-administration.jpg b/src/pages/manuals/admin/admin-management/assets/admin-search-settings-administration.jpg deleted file mode 100644 index 70ac09b59..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/admin-search-settings-administration.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/control-panel-admin-dashboard-button.jpg b/src/pages/manuals/admin/admin-management/assets/control-panel-admin-dashboard-button.jpg deleted file mode 100644 index 0c179c39a..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/control-panel-admin-dashboard-button.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/host-management/assets/control-panel-admin-dasboard-button.png b/src/pages/manuals/admin/admin-management/assets/control-panel-admin-dashboard-button.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/control-panel-admin-dasboard-button.png rename to src/pages/manuals/admin/admin-management/assets/control-panel-admin-dashboard-button.png diff --git a/src/pages/manuals/admin/admin-management/assets/control-panel-button.jpg b/src/pages/manuals/admin/admin-management/assets/control-panel-button.jpg deleted file mode 100644 index 031a56286..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/control-panel-button.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/control-panel-button.png b/src/pages/manuals/admin/admin-management/assets/control-panel-button.png new file mode 100644 index 000000000..774a4ab2b Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/control-panel-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/edit-profile.png b/src/pages/manuals/admin/admin-management/assets/edit-profile.png deleted file mode 100644 index c9cd5b6e2..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/edit-profile.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-edit-file-save-cancel-buttons.png b/src/pages/manuals/admin/admin-management/assets/file-management-edit-file-save-cancel-buttons.png new file mode 100644 index 000000000..6b0e598bc Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-edit-file-save-cancel-buttons.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-edit-file.png b/src/pages/manuals/admin/admin-management/assets/file-management-edit-file-window.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/file-management-edit-file.png rename to src/pages/manuals/admin/admin-management/assets/file-management-edit-file-window.png diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-file-delete-button.png b/src/pages/manuals/admin/admin-management/assets/file-management-file-delete-button.png new file mode 100644 index 000000000..558fbbe33 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-file-delete-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-file-delete-confirmation-window.png b/src/pages/manuals/admin/admin-management/assets/file-management-file-delete-confirmation-window.png new file mode 100644 index 000000000..fe9094e98 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-file-delete-confirmation-window.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-file-list.png b/src/pages/manuals/admin/admin-management/assets/file-management-file-list.png new file mode 100644 index 000000000..64a9f7940 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-file-list.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-search.png b/src/pages/manuals/admin/admin-management/assets/file-management-file-search.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/file-management-search.png rename to src/pages/manuals/admin/admin-management/assets/file-management-file-search.png diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permission.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permission.png new file mode 100644 index 000000000..fef8e9d16 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permission.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-add-user.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-add-user.png new file mode 100644 index 000000000..4441f9d68 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-add-user.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-browse-folder.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-browse-folder.png new file mode 100644 index 000000000..36b6f5830 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-browse-folder.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-edit-folder.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-edit-folder.png new file mode 100644 index 000000000..2be632e1b Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-edit-folder.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-example.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-example.png new file mode 100644 index 000000000..fef8e9d16 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-example.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-role.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-role.png new file mode 100644 index 000000000..51837af36 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-role.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-save.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-save.png new file mode 100644 index 000000000..be0d43e06 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-save.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-user.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-user.png new file mode 100644 index 000000000..9d892a020 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-user.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-view-folder.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-view-folder.png new file mode 100644 index 000000000..2fd33079e Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-permissions-view-folder.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-folder-settings.png b/src/pages/manuals/admin/admin-management/assets/file-management-folder-settings.png new file mode 100644 index 000000000..5dcc8f320 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-folder-settings.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-folder-button.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-button.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/file-management-upload-folder-button.png rename to src/pages/manuals/admin/admin-management/assets/file-management-upload-files-button.png diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-buttons.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-buttons.png deleted file mode 100644 index 076883cc5..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-buttons.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-choose-file-button.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-choose-file-button.png new file mode 100644 index 000000000..f155a9c0b Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-choose-file-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-choose-file.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-choose-file.png new file mode 100644 index 000000000..213fbdb99 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-choose-file.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-close-window.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-close-window.png new file mode 100644 index 000000000..127eaa96e Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-close-window.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-folder.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-folder.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/file-management-upload-folder.png rename to src/pages/manuals/admin/admin-management/assets/file-management-upload-files-folder.png diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-progress-bar.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-progress-bar.png new file mode 100644 index 000000000..f3ad6aae8 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-progress-bar.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-success-notification.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-success-notification.png new file mode 100644 index 000000000..0b37a5e6e Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-success-notification.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-upload-button.png b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-upload-button.png new file mode 100644 index 000000000..bdfb71ac5 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/file-management-upload-files-upload-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/navigation-search.jpg b/src/pages/manuals/admin/admin-management/assets/navigation-search.jpg deleted file mode 100644 index f64dc8e47..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/navigation-search.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-appearance.png b/src/pages/manuals/admin/admin-management/assets/page-appearance.png deleted file mode 100644 index bb46ae73a..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/page-appearance.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-add-page-permissions.png b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-permissions.png new file mode 100644 index 000000000..7e4344480 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-permissions.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings-appearance.png b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings-appearance.png new file mode 100644 index 000000000..7f46a46a5 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings-appearance.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings-page-content.png b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings-page-content.png new file mode 100644 index 000000000..e33ab4687 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings-page-content.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings.png b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings.png new file mode 100644 index 000000000..21367622c Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/page-management-add-page-settings.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-browse-page-button.png b/src/pages/manuals/admin/admin-management/assets/page-management-browse-page-button.png new file mode 100644 index 000000000..782c14774 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/page-management-browse-page-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-button.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-button.png new file mode 100644 index 000000000..741a25355 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-modules.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-modules.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-modules.png rename to src/pages/manuals/admin/admin-management/assets/page-management-edit-page-modules.png diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-permissions.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-permissions.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-permissions.png rename to src/pages/manuals/admin/admin-management/assets/page-management-edit-page-permissions.png diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-settings-appearance.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings-appearance.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-settings-appearance.png rename to src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings-appearance.png diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-settings-page-content.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings-page-content.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-settings-page-content.png rename to src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings-page-content.png diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-settings.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings-window.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-settings.png rename to src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings-window.png diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings.png new file mode 100644 index 000000000..54699b609 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-settings.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-theme-settings.png b/src/pages/manuals/admin/admin-management/assets/page-management-edit-page-theme-settings.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-theme-settings.png rename to src/pages/manuals/admin/admin-management/assets/page-management-edit-page-theme-settings.png diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-page-action-buttons.png b/src/pages/manuals/admin/admin-management/assets/page-management-page-list-action-buttons.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-page-action-buttons.png rename to src/pages/manuals/admin/admin-management/assets/page-management-page-list-action-buttons.png diff --git a/src/pages/manuals/admin/admin-management/assets/page-management-search-page.png b/src/pages/manuals/admin/admin-management/assets/page-management-search.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/page-management-search-page.png rename to src/pages/manuals/admin/admin-management/assets/page-management-search.png diff --git a/src/pages/manuals/admin/admin-management/assets/permissions.png b/src/pages/manuals/admin/admin-management/assets/permissions.png deleted file mode 100644 index 74b35ebd9..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/permissions.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/profile-management-add.png b/src/pages/manuals/admin/admin-management/assets/profile-management-add-settings-window.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/profile-management-add.png rename to src/pages/manuals/admin/admin-management/assets/profile-management-add-settings-window.png diff --git a/src/pages/manuals/admin/admin-management/assets/profile-management-edit.png b/src/pages/manuals/admin/admin-management/assets/profile-management-edit-settings-window.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/profile-management-edit.png rename to src/pages/manuals/admin/admin-management/assets/profile-management-edit-settings-window.png diff --git a/src/pages/manuals/admin/admin-management/assets/role-management-add.png b/src/pages/manuals/admin/admin-management/assets/role-management-add-edit-window.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/role-management-add.png rename to src/pages/manuals/admin/admin-management/assets/role-management-add-edit-window.png diff --git a/src/pages/manuals/admin/admin-management/assets/role-management-users.png b/src/pages/manuals/admin/admin-management/assets/role-management-users-window.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/role-management-users.png rename to src/pages/manuals/admin/admin-management/assets/role-management-users-window.png diff --git a/src/pages/manuals/admin/admin-management/assets/search-navigation-menu.png b/src/pages/manuals/admin/admin-management/assets/search-navigation-menu.png new file mode 100644 index 000000000..6b57732ec Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/search-navigation-menu.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/search-reindex-button.jpg b/src/pages/manuals/admin/admin-management/assets/search-reindex-button.jpg deleted file mode 100644 index 656c13ed1..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/search-reindex-button.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/search-settings-administration.jpg b/src/pages/manuals/admin/admin-management/assets/search-settings-administration.jpg deleted file mode 100644 index 70ac09b59..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/search-settings-administration.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/search-settings-reindex-button.png b/src/pages/manuals/admin/admin-management/assets/search-settings-reindex-button.png new file mode 100644 index 000000000..b01e28cff Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/search-settings-reindex-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/search-settings.png b/src/pages/manuals/admin/admin-management/assets/search-settings.png new file mode 100644 index 000000000..d96c3054f Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/search-settings.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/site-settings-1.png b/src/pages/manuals/admin/admin-management/assets/site-settings-1.png deleted file mode 100644 index 9d3fb1f23..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/site-settings-1.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/site-settings-2.png b/src/pages/manuals/admin/admin-management/assets/site-settings-2.png deleted file mode 100644 index 1aeabcf06..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/site-settings-2.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/site-setings-appearance.png b/src/pages/manuals/admin/admin-management/assets/site-settings-appearance.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/site-setings-appearance.png rename to src/pages/manuals/admin/admin-management/assets/site-settings-appearance.png diff --git a/src/pages/manuals/admin/admin-management/assets/smtp-settings.png b/src/pages/manuals/admin/admin-management/assets/smtp-settings.png deleted file mode 100644 index a5fbdbc52..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/smtp-settings.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-identity.png b/src/pages/manuals/admin/admin-management/assets/user-identity.png deleted file mode 100644 index b92b73615..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/user-identity.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-add-edit-profile.png b/src/pages/manuals/admin/admin-management/assets/user-management-add-edit-profile.png new file mode 100644 index 000000000..d4431d9ea Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-add-edit-profile.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-add-user-button.png b/src/pages/manuals/admin/admin-management/assets/user-management-add-user-button.png new file mode 100644 index 000000000..2be2e576d Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-add-user-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-add-user-identity.png b/src/pages/manuals/admin/admin-management/assets/user-management-add-user-identity.png new file mode 100644 index 000000000..8a4cf67e1 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-add-user-identity.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-edit-button.png b/src/pages/manuals/admin/admin-management/assets/user-management-edit-button.png new file mode 100644 index 000000000..b4f275c46 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-edit-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-edit-user-identity.png b/src/pages/manuals/admin/admin-management/assets/user-management-edit-user-identity.png new file mode 100644 index 000000000..6f75fa73d Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-edit-user-identity.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-import-users-button.png b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-button.png new file mode 100644 index 000000000..3453ac8d2 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-import-users-template-button.png b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-template-button.png new file mode 100644 index 000000000..03bd9301d Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-template-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-import-users-template-text-file.png b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-template-text-file.png new file mode 100644 index 000000000..31d80e224 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-template-text-file.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-import-users-upload-template.png b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-upload-template.png new file mode 100644 index 000000000..be45d4577 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-import-users-upload-template.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-import-users.png b/src/pages/manuals/admin/admin-management/assets/user-management-import-users.png new file mode 100644 index 000000000..0e92b0fa7 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-import-users.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-roles-button.png b/src/pages/manuals/admin/admin-management/assets/user-management-roles-button.png new file mode 100644 index 000000000..0d02f1f3d Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-roles-button.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-roles.png b/src/pages/manuals/admin/admin-management/assets/user-management-roles.png new file mode 100644 index 000000000..32afbeef2 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-roles.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-search-users.png b/src/pages/manuals/admin/admin-management/assets/user-management-search-users.png new file mode 100644 index 000000000..73dd01842 Binary files /dev/null and b/src/pages/manuals/admin/admin-management/assets/user-management-search-users.png differ diff --git a/src/pages/manuals/admin/admin-management/assets/user-management-settings-user-settings.png b/src/pages/manuals/admin/admin-management/assets/user-management-settings.png similarity index 100% rename from src/pages/manuals/admin/admin-management/assets/user-management-settings-user-settings.png rename to src/pages/manuals/admin/admin-management/assets/user-management-settings.png diff --git a/src/pages/manuals/admin/admin-management/assets/user-profile.png b/src/pages/manuals/admin/admin-management/assets/user-profile.png deleted file mode 100644 index 60cade834..000000000 Binary files a/src/pages/manuals/admin/admin-management/assets/user-profile.png and /dev/null differ diff --git a/src/pages/manuals/admin/admin-management/file-management.md b/src/pages/manuals/admin/admin-management/file-management.md index f02d3f51d..0177f9fe6 100644 --- a/src/pages/manuals/admin/admin-management/file-management.md +++ b/src/pages/manuals/admin/admin-management/file-management.md @@ -1,9 +1,255 @@ # File Management +![File Management](./assets/file-management.png) + Nearly everything you could need to do with files and folders in Oqtane can be done from this view. You have the ability to upload, edit, and delete files and folders. You can also control where files are stored and what permissions should be applied to which folders. Folder permissions specified by roles allow you to determine who can see folders and files and who is allowed to modify the contents of a folder. The options provided by the file manager are: * A drop down menu to select the file in which you what your view to placed in. * Edit Folder: Lets you change the parent of the folder, the name of the folder, and the permissions for what roles are able to see and access the folder and its files. * Add Folder: Allows you to create a new folder with the ability to choose a name, parent folder, and permissions to access. * Upload Files: This is the feature that allows for user to upload files like images from their local system to a folder in Oqtane and allows for files to downloaded from Oqtane to their local system. -![file-management](./assets/file-management.png) + + + + +# Add/Edit Folder Feature Overview + +The **Add/Edit Folder** features allows users to organize content within the application efficiently. By creating folders, users can categorize and manage their files according to their needs. This feature provides options for setting various parameters, such as folder type, image sizes, and capacity, ensuring flexibility in how users store and access their content. + +## Accessing the Add/Edit Folder Feature + +To add a folder, follow these steps: + +1. **Locate the Add or Edit Folder Button**: In the main user interface, find the **Add Folder** + +![Add Folder Button](./assets/file-management-add-folder-button.png) + +or **Edit Folder** button. + +![Add Folder Button](./assets/file-management-edit-folder-button.png) + +2. **Open the Modal Window**: Click on the **Add Folder** or **Edit Folder** button to open the modal window where you can configure the new folder's settings and permissions. + +![Folder Settings](./assets/file-management-folder-settings.png) + +## Folder Settings Tab + +When the modal window opens, you will see the following fields: + +1. **Parent Folder**: + - **Description**: Select the parent folder under which this new folder will be created. This helps maintain a clear hierarchy within your content organization. + +2. **Folder Name**: + - **Description**: Enter a name for the new folder. This name will be displayed in the folder list. + +3. **Folder Type**: + - **Description**: Choose the visibility of the folder. You can set the folder as either: + - **Private**: Accessible only to the user who created it. + - **Public**: Accessible to all users within the application. + +4. **Image Sizes**: + - **Description**: Specify the allowed image sizes for files that will be uploaded to this folder. This helps maintain consistency in file dimensions. + +5. **Capacity**: + - **Description**: Define the maximum storage capacity for the folder. This ensures that users do not exceed their allotted storage. + +6. **Buttons**: + - **Save**: Save the new folder configuration. + - **Cancel**: Close the modal window without saving changes. + +## Permissions Tab + +The **Permissions** tab allows users to manage access to the newly created folder based on defined roles within the application. By setting permissions, users can control who can view, edit, or manage the contents of the folder. + +### Accessing the Permissions Tab + +After opening the **Add Folder** modal window, navigate to the **Permissions** tab. + +![Permissions Tab](./assets/file-management-folder-permissions.png) + +### Permissions Configuration Options + +The following options are available in the Permissions tab: + +1. **Role Permissions**: + - **Description**: A list of roles for which you want to set permissions. + + ![Role Selection](./assets/file-management-folder-permissions-role.png) + +1. **User Permissions**: + - **Description**: A list of users for which you want to set permissions. (This is only displayed if at least one user has been added to be granted permissions.) + ![User Selection](./assets/file-management-folder-permissions-user.png) + +2. **Browse Folder Permission**: + - **Description**: Check or uncheck this option to allow or deny the selected role or user the ability to browse the folder and its contents. + - **Control**: Checkbox labeled **Browse Folder**. + + ![Browse Folder Permission](./assets/file-management-folder-permissions-browse-folder.png) + +3. **View Folder Permission**: + - **Description**: Check or uncheck this option to allow or deny the selected role the ability to view the folder and its contents (e.g., add, delete, or rename files). + - **Control**: Checkbox labeled **View Folder**. + + ![View Folder Permission](./assets/file-management-folder-permissions-view-folder.png) + +4. **Edit Folder Permission**: + - **Description**: Check or uncheck this option to allow or deny the selected role or user the ability to modify the folder and its contents (e.g., add, delete, or rename files). This is typically reserved for higher-level roles. + - **Control**: Checkbox labeled **Edit Folder**. + + ![Edit Folder Permissions](./assets/file-management-folder-permissions-edit-folder.png) + +5. **Add Users**: + - **Description**: Users can add permissions for multiple users by clicking the **Add** button after selecting a user from the search field below the roles permissions. This will make a section for **Users** appear which allows for easy management of permissions of one or many users. + - **Control**: Input field and button to add another role with permissions. + + ![Add Role Button](./assets/file-management-folder-permissions-add-user.png) + +6. **Save**: + - **Description**: After setting the desired settings and permissions for each click the **Save** button to apply the changes. + - **Control**: Save button at the bottom of the Permissions tab. + + ![Save Permissions](./assets/file-management-folder-permissions-save.png) + +--- + +By effectively managing folder permissions, users can ensure that sensitive content is only accessible to authorized roles, thus enhancing the security and organization of files within Oqtane. + +## Uploading a File + +The **Upload Files** feature allows users to easily transfer files from their local system to a designated folder within Oqtane. This functionality is essential for managing content effectively and ensures that users can access the necessary files whenever required. + +### Accessing the Upload Files Feature + +To upload a file, follow these steps: + +1. **Locate the Upload Files Button**: In the main file management interface, find the **Upload Files** button. + + ![Upload Files Button](./assets/file-management-upload-files-button.png) + +2. **Open the Upload Files Window**: Click on the **Upload Files** button to open the file selection window. + + ![File Selection Window](./assets/file-management-upload-files.png) + +### Uploading a File + +Once the file selection window is open, you can upload your file by following these steps: + +1. **Choose Destination Folder**: + - **Description**: In the upload window, select the destination folder where the file(s) will be stored. This can be done from a dropdown menu or by navigating through your folder structure. + - **Control**: Dropdown menu to select the destination folder. + + ![Browse Files](./assets/file-management-upload-files-folder.png) + +2. **Select File(s) to Upload**: + - **Description**: Click the **Choose Files** button to open your file explorer. Navigate to the desired file(s) on your local system and select them. + - **Control**: Browse button to choose file(s) from your system. + + ![Choose File Button](./assets/file-management-upload-files-choose-file-button.png) + + Select a file with an extension type that is allowed in the **Allowed Extentions** configuration setting located in **Site Settings** to upload. + + ![Select A File](./assets/file-management-upload-files-choose-file.png) + +3. **Confirm Upload**: + - **Description**: After selecting the files and destination, click the **Upload** button to begin the upload process. + - **Control**: Upload button to start uploading the selected file(s). + + ![Upload Button](./assets/file-management-upload-files-upload-button.png) + + > Note: You should see the file name next to the Choose Files + +### Upload Progress + +Once you initiate the upload, a progress bar will appear, showing the status of the upload. This allows you to monitor the upload process. + +![Upload Progress](./assets/file-management-upload-files-progress-bar.png) + +### Successful Upload Notification + +After the upload is complete, a notification will confirm that your files have been successfully uploaded to the designated folder. + +![Upload Success Notification](./assets/file-management-upload-files-success-notification.png) + +When done uploading files click the X on the top right to close the window. + +![Close Upload Files Window](./assets/file-management-upload-files-close-window.png) + +--- + +By following these steps, users can efficiently upload files to Oqtane, enhancing their ability to manage and organize content within the application. Ensure that the files you are uploading meet any specified requirements (such as file types and sizes) set by the folder configuration. + +If you experience an error please review our troubleshooting guides or start a github issue or discussion to get help. + +## Editing Files + +The **Edit Files** feature allows users to modify the properties of existing files within Oqtane. This functionality is essential for keeping file details up to date and ensuring that users can manage their content effectively. + +### Accessing the Edit Files Feature + +To edit a file, follow these steps: + +1. **Select a Folder**: + - **Description**: Choose the folder from which you want to edit a file. This can be done from a dropdown menu or by navigating through your folder structure. + - **Control**: Dropdown menu to select the folder. + + ![Select Folder](./assets/file-management-select-folder.png) + +2. **View Files**: + - **Description**: After selecting a folder, you will see a list of files within that folder. The file list includes the following columns: + - **Name**: The name of the file (hyperlinked to view the file). + - **Modified**: The date the file was last modified. + - **Type**: The file type (e.g., image, document). + - **Size**: The file size. + + ![File List](./assets/file-management-file-list.png) + +3. **Locate the Edit File Button**: + - **Description**: Find the **Edit File** button next to the file you wish to edit. + - **Control**: Edit File button associated with the specific file. + + ![Edit File Button](./assets/file-management-edit-file-button.png) + +4. **Open the Edit File Window**: Click on the **Edit File** button to open the editing window. + + ![Edit File Window](./assets/file-management-edit-file-window.png) + +### Edit File Window Components + +When the edit file window opens, you will see the following fields: + +1. **File Name**: + - **Description**: The current name of the file. You can edit this name as needed. + +2. **Select Folder**: + - **Description**: Choose a different folder for the file if required. This helps in organizing files into appropriate categories. + +3. **Description**: + - **Description**: Enter a description for the file to provide additional context or information about its content. + +4. **File Size**: + - **Description**: Displays the current size of the file, which is read-only and helps users understand the file's storage requirements. + +5. **Buttons**: + - **Save**: Click to save the changes made to the file properties. + - **Cancel**: Close the editing window without saving changes. + + ![Edit File Save Cancel Buttons](./assets/file-management-edit-file-save-cancel-buttons.png) + +### Deleting a File + +If you need to remove a file, you can do so by following these steps: + +1. **Locate the Delete File Button**: Next to the file you want to delete, find the **Delete File** button. + - **Control**: Delete File button associated with the specific file. + + ![Delete File Button](./assets/file-management-file-delete-button.png) + +2. **Confirm Deletion**: Click on the **Delete File** button, and confirm the action when prompted. This action will permanently remove the file from the system. + + ![Delete File Confirmation](./assets/file-management-file-delete-confirmation-window.png) + +--- + +By utilizing the **Edit Files** feature, users can ensure that their file details remain accurate and relevant, enhancing the organization and management of content within Oqtane. + + diff --git a/src/pages/manuals/admin/admin-management/index.md b/src/pages/manuals/admin/admin-management/index.md index 8b5c09199..aaf45292a 100644 --- a/src/pages/manuals/admin/admin-management/index.md +++ b/src/pages/manuals/admin/admin-management/index.md @@ -1,15 +1,84 @@ # Admin Management Introduction -The admin dashboard has a variety of different tools for administrators to use in order to better manage their website and to add a great amount of functionality to the website. By selecting the gear icon in the top right of a page while being on an administrator account, then selecting the admin dashboard option at the top of the control panel, which will bring up a menu with a variety of options that can be selected. - -![adminDash](./assets/admin-dash.png) - -The default options in the dashboard that Oqtane offers for an administrator to use are: -* Site Settings: Which provides a variety of settings to be able to modify and personalize your website with more information in the [site settings](site-settings.md). -* Page Management: Which provides a list of all pages on your website and provides the ability to to manipulate them in a variety of ways with more info on [page management](page-management.md). -* User Management: Which allows for the additional and modification of user accounts with more info on [user management](user-management.md). -* Profile Management: Which lets you specify what informational fields are available for a user to both optionally have and must have on their account with more info on [profile management](profile-management.md). -* Role Management: Which specifies what type of security group the user's account belongs in like giving an account administrative rights, with more info on [role management](role-management.md). -* File Management: Which allows the uploading of files like images to be inserted into pages with more info on [file management](file-management.md). -* Recycle Bin: Which allows for the restoration or full deletion of pages that were previously deleted with more info on [recycle bin](recycle-bin.md). -If you want to add new options to the admin dashboard, then that can be done by creating a new page either in the [control panel](../control-panel/page-management.md) or in the admin dashboard's [page management](page-management.md) and specifying that you want "Admin" as the parent of the new page. +The Admin Dashboard in Oqtane provides administrators with a powerful suite of tools to manage, customize, and control various aspects of the site. These tools enable efficient management of content, users, site settings, and other features, helping administrators maintain and personalize the site effectively. + +Administrators can access the Admin Dashboard by logging in with an administrator account, clicking on the **gear icon** in the top-right corner to open the Control Panel, and selecting the **Admin Dashboard** option. This displays a menu of options that offer a variety of functionalities to manage the website. + +![Admin Dashboard](./assets/admin-dashboard.png) + +## Control Panel Walkthrough + +The Control Panel provides quick access to additional site settings and tools: + +1. **Open the Control Panel**: Click the **gear icon** at the top right. + + ![Control Panel Icon](./assets/control-panel-button.png) + +2. **Open Admin Dashboard**: Click the **Admin Dashboard** button. + + ![Admin Dashboard Button](./assets/control-panel-admin-dashboard-button.png) + +3. **Navigate to Desired Feature**: In the Admin Dashboard, you’ll find icons for each feature available. Select the feature you wish to manage. + +--- + +## Access Permissions + +To access the Admin Dashboard, users must be assigned to the **Administrator role**. This can be done within the **User Management** feature by selecting the user and assigning them to the Administrator role. + + +--- + +## Admin Dashboard Features + +The following tools are available by default within the Admin Dashboard. Each link below will direct you to detailed documentation for that specific feature. + +### Administrator Role Admin Dashboard Features + +- **[Site Settings](site-settings.md)**: Configure site-wide settings, including site name, logo, language, and time zone. +- **[Page Management](page-management.md)**: Manage website pages—create, edit, arrange, and delete pages within the site hierarchy. +- **[User Management](user-management.md)**: Add, edit, and manage user accounts, including assigning roles and permissions. +- **[Profile Management](profile-management.md)**: Define profile fields for user accounts, ensuring necessary information is captured. +- **[Role Management](role-management.md)**: Create and manage security roles, defining user permissions across the site. +- **[File Management](file-management.md)**: Upload and manage files like images and documents for use throughout the website. +- **[Recycle Bin](recycle-bin.md)**: Restore or permanently delete items that have been removed from the site. +- **[URL Mappings](url-mappings.md)**: Manage URL redirects, handle broken links, and configure custom mappings. +- **[Visitor Management](visitor-management.md)**: Track visitor activity, manage session durations, and configure visitor tracking. +- **[Search Settings](search-settings.md)**: Configure the search index and parameters to improve search functionality. +- **[Language Management](language-management.md)**: Add and manage site languages, enabling multilingual support. + +--- + +## Extending the Admin Dashboard + +The Admin Dashboard in Oqtane is customizable, allowing administrators to add new pages or tools to extend site management capabilities. To add a custom page to the Admin Dashboard: + +1. **Access the Control Panel**: Log in as an administrator and click the **gear icon** at the top right to open the Control Panel. +2. **Navigate to Page Management**: In the Control Panel, select the **Page Management** section to access page configuration options. +3. **Create a New Admin Page**: + - Click on the **Add** button within the **Page Management** section. + - In the page creation dialog, set the **Parent Page** to **Admin**. This action will designate the new page as part of the Admin Dashboard, making it accessible to administrators. + - Customize additional settings for the new page as needed, such as specifying a page title and assigning permissions. + +4. **Save and Verify**: Once saved, the new page will appear in the Admin Dashboard, providing additional functionality to administrators. + +For further information on managing and organizing pages, visit the [Content Management - Page Management](../content-management/page-management.md) documentation. + +![Admin Dashboard Create Admin Page](./assets/admin-dashboard-new-admin-page.png) + +With this process, administrators can extend the Admin Dashboard by adding custom management tools, offering enhanced control over site content, settings, and features. + +--- + +## Quick Links to Additional Documentation + +For more in-depth information on installation and troubleshooting, refer to the following resources: + +- **[Installation Guides](../../../guides/installation/index.md)**: Detailed instructions for initial setup, including environment-specific configurations. +- **[Troubleshooting Installation Issues](../troubleshooting.md)**: Solutions for common setup issues. +- **[GitHub Discussions](https://github.com/oqtane/oqtane.framework/discussions)**: Join the Oqtane community for support and to discuss ideas. +- **[GitHub Issues](https://github.com/oqtane/oqtane.framework/issues)**: Report and view issues, or search for existing solutions. + +--- + +This updated **Admin Management Introduction** page consolidates all Admin Dashboard features, provides an overview for each tool, and directs users to specific guides for additional information. This setup ensures administrators can efficiently find and use the tools they need to manage their site. diff --git a/src/pages/manuals/admin/admin-management/page-management.md b/src/pages/manuals/admin/admin-management/page-management.md index 00044e7e8..3f48aff10 100644 --- a/src/pages/manuals/admin/admin-management/page-management.md +++ b/src/pages/manuals/admin/admin-management/page-management.md @@ -1,8 +1,9 @@ # Page Management +![page-management](./assets/page-management.png) + Pretty much every website starts out as one thing first and foremost: a collection of pages that constitute a web presence. Each page will have a purpose (we hope) and serve it well. As you have seen after the default installation of Oqtane, you are even given a home page to work with on the first load of your new site. Your next step might be to create additional pages, such as About Us, Contact Us, and more. As your site continues to become successful and grows to meet the needs of your customers and other visitors, you will undoubtedly begin to have more and more pages on your site. You'll have so many that at some point you will need to manage them from a centralized location. In other cases, you might have pages that are hidden from the menu and are not easily accessible. This is where the Page Management feature comes in to allow for a larger overview of the pages on your website, with all pages on your website viewable in a list format. These pages can be manipulated in the page manager by being able to add, edit, and delete pages. -![page-management](./assets/page-management.png) ### Add diff --git a/src/pages/manuals/admin/admin-management/profile-management.md b/src/pages/manuals/admin/admin-management/profile-management.md index d905000a8..ba44a459f 100644 --- a/src/pages/manuals/admin/admin-management/profile-management.md +++ b/src/pages/manuals/admin/admin-management/profile-management.md @@ -1,8 +1,10 @@ # Profile Management +![profile-management](./assets/profile-management.png) + The profile manager exposes one of the more powerful and under-appreciated features that Oqtane has to offer. The profile manager expose to you a few features, but the primary feature is the profile editor, which allows you to customize completely the profile fields that a user account has in nearly every way possible. This is the backbone of all of the user profile features in Oqtane. The Oqtane profile manager allows for a user to specify more things about themselves than the typical information from a basic user account. Fields from the profile can be made to be required upon making an account such as making a name or address a required field. -![profile-management](./assets/profile-management.png) + The profile page has an add profile button at the top of its page which includes: * Name: The name of the profile item as it would be accessible in the [database](../host-administration/sql-management.md). * Title: The title of the field displayed to the user. diff --git a/src/pages/manuals/admin/admin-management/recycle-bin.md b/src/pages/manuals/admin/admin-management/recycle-bin.md index 88c6b041f..a04870124 100644 --- a/src/pages/manuals/admin/admin-management/recycle-bin.md +++ b/src/pages/manuals/admin/admin-management/recycle-bin.md @@ -1,6 +1,7 @@ # Recycle Bin +![recycle-bin](./assets/recycle-bin.png) + The Recycle Bin is a very useful and often overlooked feature of Oqtane, especially for new users. Oftentimes, a newly designated administrator for a site will simply assume that when something is deleted, it is gone. The next logical step would probably be to re-create the content that was just deleted. This could lead to frustrations with Oqtane. The Recycle Bin allows you to restore the content in most cases, which can save you time and frustration. The Recycle Bin has two types of objects that can be restored, Pages and Modules. When you delete a page or a module, it will show up in the respective list. You can switch which list you're looking at by clicking the tabs at the top of the page. Clicking retore on one of the pages or modules will allow you to restore the selected item to their original place in your site. -The recycle bin feature has two options, restore and delete. With the restore button, the page or module is restored to its original location. The delete button permanently deletes the page from your website and you will cause it be removed permanently. -![recycle-bin](./assets/recycle-bin.png) +The recycle bin feature has two options, restore and delete. With the restore button, the page or module is restored to its original location. The delete button permanently deletes the page from your website and you will cause it be removed permanently. \ No newline at end of file diff --git a/src/pages/manuals/admin/admin-management/role-management.md b/src/pages/manuals/admin/admin-management/role-management.md index 46e2f2280..7a4686939 100644 --- a/src/pages/manuals/admin/admin-management/role-management.md +++ b/src/pages/manuals/admin/admin-management/role-management.md @@ -1,5 +1,7 @@ # Role Management +![Role Management](./assets/role-management.png) + Security Roles in Oqtane are nothing more than a grouping of one or more users for a purpose. That purpose is up to you. The purpose could be to see exclusive content in a specific area of the site or on specific pages in the site. It could also be to have the ability to edit content on one or more pages or to create content in a specific module, like a blog. We could go on and on. Just remember that Security Roles can be used for content targeting, editing, and hiding sections of your site. Security Roles work the same as most permissions-based systems, such as Windows. You first create a Security Role if it doesn't already exist to create a grouping of users. Then, you add one or more people to that group. Once you do that minimal setup, you can apply that group to various capabilities, permissions, and features. Permissions are set when creating or editing pages and modules by selecting which roles can edit or view them. diff --git a/src/pages/manuals/admin/admin-management/search-settings.md b/src/pages/manuals/admin/admin-management/search-settings.md index 58c56d36d..c228df918 100644 --- a/src/pages/manuals/admin/admin-management/search-settings.md +++ b/src/pages/manuals/admin/admin-management/search-settings.md @@ -1,5 +1,7 @@ # Search Manual +![Search Settings](assets/search-settings.png) + This document describes the Search module, settings, and configuration for administrators to set up effective search functionality across their Oqtane site. ## Overview @@ -50,7 +52,7 @@ This guide provides a step-by-step walkthrough for configuring the search functi To get started, locate the search feature in the navigation bar of the default theme. -![Search Feature in Navigation](assets/navigation-search.jpg) +![Search Feature in Navigation](assets/search-navigation-menu.png) --- @@ -58,7 +60,7 @@ To get started, locate the search feature in the navigation bar of the default t Next, click the control panel icon to access additional settings. -![Control Panel Icon](assets/control-panel-button.jpg) +![Control Panel Icon](assets/control-panel-button.png) --- @@ -66,7 +68,7 @@ Next, click the control panel icon to access additional settings. In the control panel, select the button to open the admin dashboard, where you can manage various site settings. -![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.jpg) +![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) --- @@ -74,7 +76,7 @@ In the control panel, select the button to open the admin dashboard, where you c Finally, in the admin dashboard, click on the search settings icon to configure your search options. -![Admin Dashboard Search Settings](assets/admin-dashboard-search-settings.jpg) +![Admin Dashboard Search Settings](assets/admin-dashboard-search-settings.png) --- @@ -82,7 +84,7 @@ Finally, in the admin dashboard, click on the search settings icon to configure Once in the search settings, you can adjust various parameters to customize how the search operates on your site. -![Admininstration Search Settings](assets/search-settings-administration.jpg) +![Admininstration Search Settings](assets/search-settings.png) ## Using the Reindex Button @@ -92,7 +94,7 @@ After configuring your search settings, you may need to reindex your content to The **Reindex** button initiates the process of scanning your site's content and updating the search index accordingly. This is essential after making changes to your site's content, structure, or search settings. -![Search Reindex Button](assets/search-reindex-button.jpg) +![Search Reindex Button](assets/search-settings-reindex-button.png) ### How to Use the Reindex Button diff --git a/src/pages/manuals/admin/admin-management/site-settings.md b/src/pages/manuals/admin/admin-management/site-settings.md index 6423f3e61..30e2125c1 100644 --- a/src/pages/manuals/admin/admin-management/site-settings.md +++ b/src/pages/manuals/admin/admin-management/site-settings.md @@ -1,5 +1,7 @@ # Site Settings +![smtp-settings](./assets/site-settings.png) + The Site Settings feature contains a large number of settings that you can use to perform high-level administrative configuration for your site. The Settings mostly contains set-it-and-forget it options that should be managed once when you build your site. Some of these settings include the default look and feel for new pages created on your site, your site logo, and default metadata for pages. The main parts of the settings are basic settings, SMTP configuration, and progressive web app configuration. ### Basic Settings @@ -11,11 +13,9 @@ Basic Settings mostly contains set-it-and-forget it options that should be manag * Favicon: Enter a favicon address or another icon address to have a default icon to appear beside each page in the navigation bar. * Default Theme: Choose a default theme tht will give a different color scheme and structure. * Default Layout: Choose how many columns a page has by default. -![site-settings-1](./assets/site-settings-1.png) * Default Container: Choose if you want titles to appear about each module by default. * Allow User Registration: Should users be able to create their own accounts or should only administrators be able to create accounts. * Is Deleted: Select whether you want to delete this site. -![site-settings-2](./assets/site-settings-2.png) ### SMTP Server (Secure Mail Transfer Protocol) The Oqtane instance sends outbound email for a variety of reasons, from the host or site admin or in the form of password reminders, event notifications, newsletters, or other business-specific use cases. A valid SMTP server is required for this to work; you should consult your network administrator for the appropriate credentials to use in a production configuration. Most non-Exchange Server SMTP hosts will require “Basic” authentication and a valid username/password combination. Some will also require that SSL be enabled. @@ -24,10 +24,10 @@ The Oqtane instance sends outbound email for a variety of reasons, from the host * SSL Enabled: Specify yes or no if the SMTP server has an SSL certificate. * Username: Enter the username for the SMTP server you are accessing. * Password: Enter the password for the SMTP server you are accessing. -![smtp-settings](./assets/smtp-settings.png) +![smtp-settings](./assets/site-settings-smtp-settings.png) ### Progressive Web Application Settings * Is Enabled: Choose whether or not you want the site to be set up as a progressive web application. * App Icon: Select a PNG image that is 192 X 192 pixels which will be the app icon for your application. * Splash Icon: Select a PNG image that is 512 X 512 pixels which will appear on the screen while the application is loading. -![pwa-settings](./assets/pwa-settings.png) +![pwa-settings](./assets/site-settings-pwa-settings.png) diff --git a/src/pages/manuals/admin/admin-management/user-management.md b/src/pages/manuals/admin/admin-management/user-management.md index 0437adae5..644bb1a67 100644 --- a/src/pages/manuals/admin/admin-management/user-management.md +++ b/src/pages/manuals/admin/admin-management/user-management.md @@ -1,13 +1,150 @@ # User Management -One of your primary responsibilities as the site administrator will likely be to manage users on your site. You might need to create, edit, or delete users. You might also be required to add and remove abilities from users on your site. Everything that you need to do in these examples can be done from this one menu. -![user-management](./assets/user-management.png) -The options that are provided on this user manager includes: -* Add User: The add new user button is exactly what it sounds like it allows you to add a new user to your site and upon being clicked, it brings up a window that asks for all of the essential information for an account with a username, password, email, and full name. There is also the profile tab which allows for more extensive information to be provided for a user account and may have some fields that are required to be input in order to create an account, which is specified in the required field of the [profile manager](profile-management.md). -* Find User: Provides a text field to input a user's account name that will search through all of the site's users and return the account below this field with the following options: - * Edit User: This allows for basic fields in the identity field such as password, email, and full name to be modified as well as the ability to give the user a profile image and the profile tab to specify more information about a user. - ![user-identity](./assets/user-identity.png) - There is also the profile tab which goes into more detail about a user allowing for the specification of things like postal code, phone number and address. - ![user-profile](./assets/user-profile.png) - * Delete User: This is exactly as it sounds, it will delete the user's account. - * User Roles: This allows for a user account to placed into a security role that has been previously defined in the [role manager](role-management.md), and requires a date that this security role will take effect and will expire for the user account. +![User Management Feature](assets/user-management.png) + +## Overview + +The **User Management** feature in Oqtane provides administrators with a centralized interface to manage site users. Here, you can add new users, edit profiles, assign roles, and delete accounts. The User Management feature is organized into two primary tabs: + +1. **Users Tab** - Manage individual users by adding, editing, deleting, and assigning roles. +2. **Settings Tab** - Configure global settings related to user profiles and management options. + +This guide will walk you through each section, detailing how to utilize the User Management feature fully. + +--- + +## Control Panel Walk-through + +### Accessing the User Management Feature + +1. Click the control panel icon to access additional settings. + + ![Control Panel Icon](assets/control-panel-button.png) + +2. In the control panel, select the button to open the admin dashboard. + + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) + +3. In the admin dashboard, click on the **User Management** icon to configure user settings and manage site users. + + ![Admin Dashboard User Management](assets/admin-dashboard-user-management.png) + +--- + +## Users Tab + +### Adding a New User + +1. Click the **Add User** button to open a new window. + + ![Add User Button](assets/user-management-add-user-button.png) + +2. In the **Identity** tab, fill in the following information: + - **Username** + - **Email** + - **Full Name** + - **Notify**: Select **Yes** or **No** to notify the user upon account creation. + + ![User Identity Tab](assets/user-management-add-user-identity.png) + +3. Switch to the **Profile** tab to input additional details, such as address, phone number, and other optional information. + + ![User Profile Tab](assets/user-management-add-edit-profile.png) + +4. After entering the necessary information, click **Save** to create the user, or **Cancel** to discard the changes. + +--- + +### Importing Users + +1. Click the **Import Users** button to add multiple users from a file. + + ![Import Users Button](assets/user-management-import-users-button.png) + +2. In the import window, specify the file source and file name. + - **Folder**: Choose the folder where the file is located. + - **File**: Select the file to import users. + - **Notify**: Choose **Yes** or **No** to send notifications to the users being imported. + + ![User Import Window](assets/user-management-import-users.png) + +3. Click **Upload** to load the file, then click **Import** to add users in bulk. +4. If you don’t have a template, you can download one by clicking the **Template** button. + + ![User Import Window](assets/user-management-import.png) + +--- + +### Searching for Users + +1. Use the search field to locate a user by **Username**, **Email**, or **DisplayName**. +2. Click **Search** to filter results or **Reset** to clear the search input. + + ![User Search Field](assets/user-management-search-users.png) + +--- + +### Editing Users + +1. To modify a user’s information, locate the user in the list and click **Edit**. + + ![Edit User Button](assets/user-management-edit-button.png) + +2. The **Edit User** window includes: + - **Identity** tab: Edit username, password, email, and name. + - **Profile** tab: Update profile details such as address, phone number, and other custom fields. + + ![Edit User Identity Tab](assets/user-management-edit-user-identity.png) + ![Edit User Profile Tab](assets/user-management-add-edit-profile.png) + +3. Click **Save** to apply the changes or **Cancel** to discard them. + +--- + +### Deleting Users + +1. Click **Delete** next to a user in the list to remove their account. +2. Confirm the deletion in the pop-up confirmation window. + +--- + +### Assigning User Roles + +1. Click the **Roles** button next to a user to manage their assigned roles. + + ![User Roles Button](assets/user-management-roles-button.png) + +2. In the **User Roles** window: + - **User**: Displays the user’s name. + - **Role**: Select a role to assign from a dropdown list. + - **Effective Date**: Choose a start date for the role. + - **Expiry Date**: Set an expiration date for the role (optional). + + ![User Roles Management](assets/user-management-roles.png) + +3. Roles currently assigned to the user are listed below with their effective and expiry dates. You can remove roles from this list if needed. +4. Click **Save** to confirm the role assignment or **Cancel** to exit without changes. + +--- + +## Settings Tab + +The **Settings Tab** within the User Management feature allows administrators to configure site-wide user settings. The following options are available: + + ![Allow Registration](assets/user-management-settings.png) + +1. **Allow Registration**: + - **Description**: This setting determines whether anonymous visitors can register for an account on the site. + - **Options**: + - **Yes**: Visitors can create accounts. + - **No**: Registration is disabled. + + > **Tip**: Allowing registration can help increase user engagement by letting visitors create personalized accounts. + +2. **Allow Login**: + - **Description**: This option specifies if users are permitted to sign in using a username and password that is managed locally on the site. + - **Options**: + - **Yes**: Users can log in with their local account credentials. + - **No**: Local login is disabled. Use this option with caution; only disable if you have successfully configured an external login provider, as it may lock you out of the site. + + > **Warning**: Ensure that an external login provider is properly set up before disabling local login to avoid losing access to the site. diff --git a/src/pages/manuals/admin/admin-management/visitor-management.md b/src/pages/manuals/admin/admin-management/visitor-management.md index b09f37901..20f74e7fb 100644 --- a/src/pages/manuals/admin/admin-management/visitor-management.md +++ b/src/pages/manuals/admin/admin-management/visitor-management.md @@ -16,15 +16,15 @@ The **Visitor Management** feature provides tools for monitoring and managing vi 1. Click the control panel icon to access additional settings. - ![Control Panel Icon](assets/control-panel-button.jpg) + ![Control Panel Icon](assets/control-panel-button.png) 2. In the control panel, select the button to open the admin dashboard. - ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.jpg) + ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.png) 3. In the admin dashboard, click on the **Visitor Management** icon to configure visitor tracking. - ![Admin Dashboard Visitor Management](assets/admin-dashboard-visitor-management.jpg) + ![Admin Dashboard Visitor Management](assets/admin-dashboard-visitor-management.png) --- diff --git a/src/pages/manuals/admin/content-management/assets/content-arrow.png b/src/pages/manuals/admin/content-management/assets/content-arrow.png deleted file mode 100644 index 4cf4e06a1..000000000 Binary files a/src/pages/manuals/admin/content-management/assets/content-arrow.png and /dev/null differ diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-module-options-caret-bottom-button.png b/src/pages/manuals/admin/content-management/assets/content-edit-module-options-caret-bottom-button.png new file mode 100644 index 000000000..a7174fb1c Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/content-edit-module-options-caret-bottom-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/navigation-menu-content-edit-button.png b/src/pages/manuals/admin/content-management/assets/content-editor-button.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/navigation-menu-content-edit-button.png rename to src/pages/manuals/admin/content-management/assets/content-editor-button.png diff --git a/src/pages/manuals/admin/content-management/assets/navigation-menu-content-edit-mode-button.png b/src/pages/manuals/admin/content-management/assets/content-editor-enabled-button.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/navigation-menu-content-edit-mode-button.png rename to src/pages/manuals/admin/content-management/assets/content-editor-enabled-button.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-html-editor-edit-content-button.png b/src/pages/manuals/admin/content-management/assets/content-editor-html-editor-edit-content-button.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-html-editor-edit-content-button.png rename to src/pages/manuals/admin/content-management/assets/content-editor-html-editor-edit-content-button.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-module-button-options.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-button-options.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-module-button-options.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-button-options.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-modules-options-button.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-button.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-modules-options-button.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-button.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-delete-module.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-delete-module.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-delete-module.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-delete-module.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-import-export-content.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-import-export-content.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-import-export-content.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-import-export-content.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-manage-settings.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-manage-settings.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-manage-settings.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-manage-settings.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move-to-pane.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-move-to-pane.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move-to-pane.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-move-to-pane.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-move.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-move.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-move.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-unpublish-module.png b/src/pages/manuals/admin/content-management/assets/content-editor-module-options-unpublish-module.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-module-options-unpublish-module.png rename to src/pages/manuals/admin/content-management/assets/content-editor-module-options-unpublish-module.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-pane-border.png b/src/pages/manuals/admin/content-management/assets/content-editor-pane-border.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-pane-border.png rename to src/pages/manuals/admin/content-management/assets/content-editor-pane-border.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-pane-name.png b/src/pages/manuals/admin/content-management/assets/content-editor-pane-name.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-pane-name.png rename to src/pages/manuals/admin/content-management/assets/content-editor-pane-name.png diff --git a/src/pages/manuals/admin/content-management/assets/content-edit-mode-pane.png b/src/pages/manuals/admin/content-management/assets/content-editor-pane.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/content-edit-mode-pane.png rename to src/pages/manuals/admin/content-management/assets/content-editor-pane.png diff --git a/src/pages/manuals/admin/content-management/assets/control-panel-button.jpg b/src/pages/manuals/admin/content-management/assets/control-panel-button.jpg deleted file mode 100644 index 031a56286..000000000 Binary files a/src/pages/manuals/admin/content-management/assets/control-panel-button.jpg and /dev/null differ diff --git a/src/pages/manuals/admin/content-management/assets/control-panel-button.png b/src/pages/manuals/admin/content-management/assets/control-panel-button.png new file mode 100644 index 000000000..774a4ab2b Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/control-panel-button.png differ diff --git a/src/pages/manuals/admin/host-management/assets/control-panel-icon-button.png b/src/pages/manuals/admin/content-management/assets/control-panel-icon-button.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/control-panel-icon-button.png rename to src/pages/manuals/admin/content-management/assets/control-panel-icon-button.png diff --git a/src/pages/manuals/admin/content-management/assets/page-management-add-button.png b/src/pages/manuals/admin/content-management/assets/control-panel-page-management-add-button.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/page-management-add-button.png rename to src/pages/manuals/admin/content-management/assets/control-panel-page-management-add-button.png diff --git a/src/pages/manuals/admin/content-management/assets/control-panel-page-management-delete-button.png b/src/pages/manuals/admin/content-management/assets/control-panel-page-management-delete-button.png new file mode 100644 index 000000000..5aefbb1c6 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/control-panel-page-management-delete-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/page-management-edit-button.png b/src/pages/manuals/admin/content-management/assets/control-panel-page-management-edit-button.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/page-management-edit-button.png rename to src/pages/manuals/admin/content-management/assets/control-panel-page-management-edit-button.png diff --git a/src/pages/manuals/admin/content-management/assets/control-panel-page-management-publish-button.png b/src/pages/manuals/admin/content-management/assets/control-panel-page-management-publish-button.png new file mode 100644 index 000000000..8faacdc05 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/control-panel-page-management-publish-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-edit-content-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-edit-content-button.png new file mode 100644 index 000000000..54d0f1515 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-edit-content-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-image-selected.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-image-selected.png new file mode 100644 index 000000000..44d921ae7 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-image-selected.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-image-upload-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-image-upload-button.png new file mode 100644 index 000000000..c3a9cac55 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-image-upload-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-insert-image-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-insert-image-button.png new file mode 100644 index 000000000..104bfae97 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-insert-image-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-insert-image-select-file.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-insert-image-select-file.png new file mode 100644 index 000000000..fdbc10297 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-insert-image-select-file.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-raw-html-editor.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-raw-html-editor.png new file mode 100644 index 000000000..9386021e0 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-raw-html-editor.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-raw-html.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-raw-html.png deleted file mode 100644 index 8b8d17363..000000000 Binary files a/src/pages/manuals/admin/content-management/assets/html-text-editor-raw-html.png and /dev/null differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-rich-text-editor.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-rich-text-editor.png new file mode 100644 index 000000000..bd2a4d684 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-rich-text-editor.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-save-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-save-button.png new file mode 100644 index 000000000..12c982200 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-save-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-confirm-delete-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-confirm-delete-button.png new file mode 100644 index 000000000..5764ed3c7 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-confirm-delete-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-confirm-restore-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-confirm-restore-button.png new file mode 100644 index 000000000..b7c54432b Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-confirm-restore-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-delete-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-delete-button.png new file mode 100644 index 000000000..852661d26 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-delete-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-restore-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-restore-button.png new file mode 100644 index 000000000..a46481785 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-restore-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-view-button.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-view-button.png new file mode 100644 index 000000000..2a7c485a2 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-view-button.png differ diff --git a/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-view.png b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-view.png new file mode 100644 index 000000000..519bf39e3 Binary files /dev/null and b/src/pages/manuals/admin/content-management/assets/html-text-editor-versions-view.png differ diff --git a/src/pages/manuals/admin/content-management/assets/page-management-permissions.png b/src/pages/manuals/admin/content-management/assets/page-management-add-permissions.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/page-management-permissions.png rename to src/pages/manuals/admin/content-management/assets/page-management-add-permissions.png diff --git a/src/pages/manuals/admin/content-management/assets/page-management-settings.png b/src/pages/manuals/admin/content-management/assets/page-management-add-settings.png similarity index 100% rename from src/pages/manuals/admin/content-management/assets/page-management-settings.png rename to src/pages/manuals/admin/content-management/assets/page-management-add-settings.png diff --git a/src/pages/manuals/admin/content-management/assets/page-management.png b/src/pages/manuals/admin/content-management/assets/page-management.png deleted file mode 100644 index f18b3c1bc..000000000 Binary files a/src/pages/manuals/admin/content-management/assets/page-management.png and /dev/null differ diff --git a/src/pages/manuals/admin/content-management/content-editor.md b/src/pages/manuals/admin/content-management/content-editor.md index 0ef82cb46..c22ec83c5 100644 --- a/src/pages/manuals/admin/content-management/content-editor.md +++ b/src/pages/manuals/admin/content-management/content-editor.md @@ -1,30 +1,97 @@ # Content Editor -The content editor is what allows you to edit the modules on the page in a variety of ways. You access the content editor by clicking on the pencil on the top right side of the page which then shows the borders of the content pane which the modules are put inside of, as well as a small downward pointing arrow beside each module that allows you to open a menu to interact with the modules. - -![pencil-edit](./assets/pencil-edit.png) - -![content-arrow](./assets/content-arrow.png) - -The options for the module's menu are: - -* Manage Settings: Brings up the module's settings and permissions which allow you to change the: - * Title: The title displayed above the module. - * Container: Specify if you want the title to be displayed for the module. - * Display on All Pages: Choose whether you want this module to be on every page on the site. - * Page: Change the page that the module is displayed on. - * Permissions: Specify either what [roles](../admin-dashboard/role-management.md) or individual users should be able to view or edit the page. -* Unpublish Module: Hides the module from everyone, but the site administrators for instances where you want to edit modules. -* Delete Module: Deletes the module from the page. -* Import Content: Enter a file's address to import it into the module, such as a image address to include it. -* Export Content: Enter a file address to select where to export data from a module. -* 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. -* Move to Bottom: Moves the module to the bottom of the page, below all other modules. -If the page has the layout for multiple panes, which will allows for three center rows and a top and bottom row that can have content inserted into them, then there will be additional options available which are: -* Move to Top Pane: Moves the module to the content pane at the top of the page. -* Move to Left Pane: Moves the module to the left-most column. -* 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. +The **Content Editor** allows you to edit the modules on the page in various ways. You can access the Content Editor by clicking on the pencil icon located at the top right side of the page. This action will display the borders of the content panes where the modules are placed and a small downward-pointing arrow next to each module, enabling you to open a menu for module interaction. + + +![Pencil Edit Icon](./assets/content-editor-button.png) +*Click on this icon button to enable the Content Editor.* + +![Pencil Edit Enabled Icon](./assets/content-editor-enabled-button.png) +*Click on this button again to disable the Content Editor. Notice how the appearance of the pencil icon changes between enabled and disabled states.* + +When the Content Editor is enabled, borders around each content pane are displayed, indicating the layout of the theme. + +![Content Pane Border](./assets/content-editor-pane-border.png) +*The visible borders help you understand the layout of the page when in edit mode.* + +## Pane Header + +When the Content Editor is activated, the top header of the pane is displayed, showing the name of the pane: + +![Pane Header](./assets/content-editor-pane.png) +![Pane Name Display](./assets/content-editor-pane-name.png) + +## Module Menu Options + +When you click the downward-pointing "caret-bottom" arrow next to a module, you have access to the following options: + + ![Unpublish/Publish Module Menu Options Button](./assets/content-editor-module-options-caret-bottom-button.png) + + +- **Manage Settings**: Opens the module's settings and permissions, allowing you to change the: + - **Title**: The title displayed above the module. + - **Container**: Specify whether you want the title to be displayed for the module. + - **Display on All Pages**: Choose whether this module should appear on every page of the site. + - **Page**: Change the page on which the module is displayed. + - **Permissions**: Specify which [roles](../admin-management/role-management.md) or individual users can view or edit the module. + +- **Unpublish Module**: Hides the module from all users except site administrators, useful for when you want to make edits without public visibility. + + ![Unpublish/Publish Module Option](./assets/content-editor-module-options-unpublish-module.png) + +- **Delete Module**: Permanently removes the module from the page. + +- **Import Content**: Enter a file's address (e.g., an image URL) to import it into the module. + +- **Export Content**: Specify a file address to determine where to export data from the module. + +- **Move to Top**: Moves the module to the top of the page, making it the first displayed module. + +- **Move Up**: Moves the module up one position, placing it above the module currently above it. + +- **Move Down**: Moves the module down one position, placing it below the module currently below it. + +- **Move to Bottom**: Moves the module to the bottom of the page, below all other modules. + +- **Move Options**: When you select "Move to," additional options will be available, allowing you to choose a specific pane for the module. + + ![Move Options](./assets/content-editor-module-options-move.png) + +If the page layout includes multiple panes (e.g., three center rows, a top row, and a bottom row), you can select from various options to reposition your module across these panes: + +- **Move to Top Pane**: Moves the module to the content pane at the top of the page. +- **Move to Left Pane**: Moves the module to the left-most column. +- **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 content pane at the bottom of the page. + +![Move to Pane Options](./assets/content-editor-module-options-move-to-pane.png) + +The **Move to Pane** feature is adaptable to different themes, and the available panes vary depending on the layout provided by the theme. In the example shown in the image, you’ll see a variety of pane options that a more complex theme might offer, giving administrators greater flexibility in organizing modules. + +For instance, the default Oqtane theme includes not only standard rows and columns but also numerous additional panes, which allow for a wide range of layout possibilities. While simpler themes may only display a few basic options, the default theme might provide over 20 panes, including: + +- **Full-Width Panes**: These panes span the entire width of the page. Examples include: + - **Top Full Width Pane**: A full-width pane at the top of the page. + - **Bottom Full Width Pane**: A full-width pane at the bottom of the page. + +- **100% Width Panes**: These also span the full width, but are distinct from other full-width panes in terms of placement: + - **Top 100% Pane**: Positioned below the top full-width pane, occupying the full page width. + - **Bottom 100% Pane**: Positioned above the bottom full-width pane, also spanning the entire page width. + +- **50%/50% Split Panes**: Divide the page into two equal sections: + - **Left 50% Pane** and **Right 50% Pane**. + +- **33%/33%/33% Split Panes**: For a balanced three-column layout: + - **Left 33% Pane**, **Center 33% Pane**, and **Right 33% Pane**. + +- **25%/25%/25%/25% Split Panes**: For a four-column layout: + - **Left Outer 25% Pane**, **Left Inner 25% Pane**, **Right Inner 25% Pane**, and **Right Outer 25% Pane**. + +- **Asymmetrical Ratios**: Options like: + - **Left 66% Pane** and **Right 33% Pane**. + - **Left 33% Pane** and **Right 66% Pane**. + +- **Footer Pane**: An additional pane often reserved for footer content. + +These pane options let administrators place modules precisely within the layout structure, which is divided into sections adding up to 100% of the layout width. The image shows this range of options, giving a visual reference of the **Move To >** menu options when working with themes that support complex layouts. This flexibility enables customized content presentation to best suit each page’s design. \ No newline at end of file diff --git a/src/pages/manuals/admin/content-management/control-panel.md b/src/pages/manuals/admin/content-management/control-panel.md index e20f58a51..abe6b36d2 100644 --- a/src/pages/manuals/admin/content-management/control-panel.md +++ b/src/pages/manuals/admin/content-management/control-panel.md @@ -1,14 +1,43 @@ # Control Panel -Site administration in Oqtane is the processes, tasks, and features that it takes to effectively run a website in Oqtane. -This includes things like managing users, security, site settings, configurations, and content using the features available to them, in both the [control panel](../control-panel/index.md) and the [admin dashboard](../admin-dashboard/index.md). +Site administration in Oqtane involves using features like managing users, security, settings, configurations, and content to effectively run a website. The Control Panel is a primary tool for handling these tasks, providing options to manage pages, modules, and access site settings. -![control-panel](./assets/control-panel.png) +Users with the **Administrators** role can access the Control Panel by logging in with an account that has the appropriate permissions for site administration. This guide provides instructions on accessing the Control Panel, adding and managing pages and modules, and includes logout instructions. -Site administration can take on many forms, but there are two use cases that you should be familiar with. First, there's site administration as defined by Oqtane.You enable this by adding the Administrators security role as one of the assigned roles for the account. That way, all “admin” features will be available for that user across that specific site. +![Control Panel](./assets/control-panel.png) -Site administration can take on a hybrid of another sort as well, where you as the site administrator can define a different kind of administration for your site. This would be a kind of administration where you define a subset of administration capabilities and assign them to more privileged users to avoid having to make them an actual administrator. +--- -As an example, there may be times when you want to create a security role in the [role manager](/admin/admin-dashboard/role-management.md) that might be named something like Site Admin. You would then create a page or pages on the site that contain some of the Admin modules, assigning permission to the newly created Site Admin security role so that only participants of that security role can see them. In these areas, you can also add references or links to features that normally require Administrator permissions, provided you set up your permissions properly in those other areas and that the chosen feature(s) allows this. +## Accessing the Control Panel -In summary, you can perform all of the configuration and content management tasks that you need to in order to run your own site. +To open the Control Panel: +1. **Log in to Oqtane**: Ensure that you're logged in with a user account assigned to the Administrators role. +2. **Click the Control Panel Icon**: Once logged in, you’ll see the Control Panel icon. +![Control Panel Icon](./assets/control-panel-icon-button.png) +Click this icon to open the Control Panel menu. This will expand the menu and provide access to various management features within the Control Panel. + +--- + +## Control Panel Options + +Once the Control Panel is open, several administrative options become available: + +1. **Page Management**: + - Allows users to add, edit, delete, and publish pages. + - For more detailed information, visit this section's [Control Panel Page Management Documentation](./page-management.md). + - ![Page Management](./assets/control-panel-page-management.png) + +2. **Module Management**: + - Provides tools for adding, editing, and deleting modules on a page. + - For more detailed information, visit this section's [Control Panel Module Management Documentation](./module-management.md). + - ![Module Management](./assets/control-panel-module-management.png) + +3. **Logout**: + - An option to securely log out of Oqtane. + - ![Logout Button](./assets/control-panel-logout-button.png) + +--- + +### Summary + +The Control Panel is an essential component for site administration in Oqtane, enabling users to effectively manage their website's structure and content. By utilizing the Page Management and Module Management features, administrators can ensure their site operates smoothly and meets user needs. diff --git a/src/pages/manuals/admin/content-management/html-text-editor.md b/src/pages/manuals/admin/content-management/html-text-editor.md new file mode 100644 index 000000000..5d4a5d205 --- /dev/null +++ b/src/pages/manuals/admin/content-management/html-text-editor.md @@ -0,0 +1,110 @@ +# HTML/Text Editor + +The HTML/Text Editor module in Oqtane enables you to create, edit, and restore content using a rich text editor (WYSIWYG) and a raw HTML editor. This module is ideal for exploring Oqtane’s editing and content management features, including moving modules between panes, configuring settings, and managing roles. + +![HTML/Text Editor](./assets/html-text-editor.png) + +**To access the HTML/Text Editor:** +1. Enter Content Editor mode by clicking the pencil icon. + + ![HTML/Text Editor Edit Content Mode](./assets/content-editor-edit-content-button.png) + +2. Click the **Edit Content** button on the module to open the HTML/Text Editor. + + ![HTML/Text Editor Edit Content Button](./assets/html-text-editor-edit-content-button.png) + +The editor has two main tabs: + +1. **Edit** – Contains content editing tools. +2. **Versions** – Manages past content versions with options to view, restore, and delete. + +### Edit Tab + +The Edit tab provides three sub-tabs for different editing options: + +* **Rich Text Editor** – A WYSIWYG editor powered by QuillJS (v1.3.7), providing an easy way to format content visually. + + ![HTML/Text Editor Rich Text Editor](./assets/html-text-editor-rich-text-editor.png) + +* **Raw HTML Editor** – Enables direct HTML editing for more control over the source code. + + ![HTML/Text Editor Raw HTML Editor](./assets/html-text-editor-raw-html-editor.png) + +* **Settings** – Provides configuration options for the editor’s features. + +#### Rich Text Editor Settings + +In the **Settings** sub-tab, you can customize the editor with the following options: + +- **Enable Rich Text Editor?** - Yes +- **Enable Raw HTML Editor?** - Yes +- **Insert Images?** - Yes +- **Theme**: Options like "snow" theme +- **Debug Level**: Example setting "info" +- **Toolbar Content**: Define the editor’s toolbar + + ![HTML/Text Editor Settings Tab](./assets/html-text-editor-settings.png) + +Each editor (Rich Text and HTML) includes an **"Insert Image"** button that opens a dialog with the following options: + + ![HTML/Text Editor Insert Image Button](./assets/html-text-editor-insert-image-button.png) + +- **Select Folder** – Choose the folder where images are stored. +- **Select File** – Pick an image file from the selected folder. + + ![HTML/Text Editor Select Folder/File](./assets/html-text-editor-select-folder-file.png) + +Once an image file is selected, click the **Insert Image** button. + + ![HTML/Text Editor Image Selected](./assets/html-text-editor-image-selected.png) + +- **Upload File** – Upload new images to the selected folder by using **Choose File** and **Upload** buttons. + + ![HTML/Text Editor Upload File Button](./assets/html-text-editor-upload-file-button.png) + +If you encounter issues with uploading files, see the [Troubleshooting File Manager](../../guides/troubleshooting/troubleshooting-file-manager.md) guide. + +After uploading the image to the selected folder, click the **Insert Image** button. + +#### Saving Edits + +After making changes in the editor, click the **Save** button to confirm and save the settings and content updates. + + ![HTML/Text Editor Save Button](./assets/html-text-editor-save-button.png) + +--- + +### Versions Tab + +The Versions tab displays a list of previous content versions, along with: + +* **CreatedOn** – The date each version was created. +* **CreatedBy** – The user who created the version. + + ![HTML/Text Editor Versions Tab](./assets/html-text-editor-versions.png) + +Each version offers the following actions: + +- **View** – Shows the selected version’s content. + + ![HTML/Text Editor Versions View Button](./assets/html-text-editor-versions-view-button.png) + + Below is an example of what the **View** button will display at the bottom of the modal window. + + ![HTML/Text Editor Versions View Content](./assets/html-text-editor-versions-view.png) + +- **Restore** – Restores the module content to this version. + + ![HTML/Text Editor Versions Restore Button](./assets/html-text-editor-versions-restore-button.png) + + After clicking **Restore**, you will be prompted to confirm. To proceed, click the **Restore** button in the confirmation window. + + ![HTML/Text Editor Confirm Restore Button](./assets/html-text-editor-versions-confirm-restore-button.png) + +- **Delete** – Removes the selected version from the list. + + ![HTML/Text Editor Versions Delete Button](./assets/html-text-editor-versions-delete-button.png) + + After clicking **Delete**, you will be prompted to confirm. To proceed, click the **Delete** button in the confirmation window. + + ![HTML/Text Editor Versions Confirm Delete Button](./assets/html-text-editor-versions-confirm-delete-button.png) diff --git a/src/pages/manuals/admin/content-management/image.png b/src/pages/manuals/admin/content-management/image.png new file mode 100644 index 000000000..7d02f9e18 Binary files /dev/null and b/src/pages/manuals/admin/content-management/image.png differ diff --git a/src/pages/manuals/admin/content-management/index.md b/src/pages/manuals/admin/content-management/index.md index 878148ce0..50cdebd73 100644 --- a/src/pages/manuals/admin/content-management/index.md +++ b/src/pages/manuals/admin/content-management/index.md @@ -1,12 +1,15 @@ -# Content Management Introduction +# Content Management -When managing your Oqtane site as an administrator, you will most likely be doing most of your daily work in the Control Panel. As an administrator, you will be able to use nearly every part of the Control Panel. The control panel is accessible through the gear icon located in the top right-hand corner of the screen and provides the ability to interact with the: +## Introduction -* [admin dashboard](../admin-dashboard/index.md) -* [page manager](page-management.md) -* [module manager](modules.md) +When managing your Oqtane site as an administrator, most of your daily tasks will likely involve the Control Panel. As an administrator, you have access to nearly every feature of the Control Panel. Access the Control Panel via the gear icon located in the top right-hand corner of the screen. The Control Panel provides tools for: -![control-panel](./assets/control-panel.png) +* [Control Panel](control-panel.md) +* [Page Management](page-management.md) +* [Module Management](module-management.md) +* [Content Editor](content-editor.md) +* [HTML/Text Editor](html-text-editor.md) -Those with content management permissions, which are defined by a user account's roles, in Oqtane are often referred to as “content editors.” Content editors can typically view only some of the Control Panel—the parts that are required in order to perform other related tasks, such as adding a module to a page. -It is worth noting that the Control Panel you'll be using is the one that ships “out of the box” with Oqtane. However, it is one of numerous extension points in Oqtane. Like modules, themes, and other extensions, the Control Panel can be replaced with a custom or third-party alternative. +In Oqtane, users with content management permissions, defined by their roles, are referred to as “content editors.” Content editors typically access only the necessary sections of the Control Panel to perform tasks like adding or editing a module on a page. + +The Control Panel provided with Oqtane is the default, but it can be replaced with a custom or third-party option, like other extensions in Oqtane such as modules, themes, and more. diff --git a/src/pages/manuals/admin/content-management/module-management.md b/src/pages/manuals/admin/content-management/module-management.md index 293b76ae6..c3580276d 100644 --- a/src/pages/manuals/admin/content-management/module-management.md +++ b/src/pages/manuals/admin/content-management/module-management.md @@ -1,24 +1,55 @@ # Module Management -Modules are a key feature of Oqtane as they allow for you to insert a massive variety of things into your web page. -There are a wide variety of different that can be added to your page for a high level of customization. -An administrator also has the ability to both download new modules onto the website or upload modules you have created to the marketplace, -options which are found in the admin dashboard's [module management feature](../modules/index.md). - -On the side control panel's module management section, you have the option to: -* Add A New Module: which will put a new module of your choosing onto the page which has the option of being a: - * 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. - * Developer Module: This feature is for placing a module creator onto a page which will provide you with useful pre-built structure and methods for writing code for your own modules. - -* Add An Existing Module: Provides the ability to select modules that are already on other pages from your website. - * Page: A list of other your other web pages where you can select a page on your site that has the module you would like. - * Modules: A list of modules that are on the selected web page for you to select. - -Directly below these options, when a module is selected, the module's description will appear in a purple box so you have a better understanding of what the module is for. -The other module options below this are: -* 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). -* Container: Select if you would like to have a title displayed above the module or not have one. - -![control-panel-module](./assets/control-panel-modules.png) +Modules are a key feature of Oqtane, allowing you to insert a diverse array of components into your web pages. With a variety of modules available, you can customize your site extensively. Administrators have the ability to download new modules or upload custom modules to the marketplace, which can be accessed via the admin dashboard's [Module Management feature](../modules/index.md). + +## Accessing Module Management + +To access the Module Management feature in the Control Panel: +1. **Log in to Oqtane** with an account assigned to the Administrators role. +2. **Click the Control Panel Icon**: Once logged in, click the Control Panel icon to open the Control Panel menu. +3. **Select Module Management**: Click on the **Module Management** option in the Control Panel. + +![Control Panel Module Management](./assets/control-panel-module-management.png) + +--- + +## Module Management Options + +In the Control Panel’s Module Management section, you have the following options: + +### Add New Module + +This option allows you to place a new module of your choice onto the page: + +1. **Select Category**: + - **Admin Modules**: Modules available only to users with the Administrator role. + - **Common Modules**: Modules accessible to both Administrators and registered users. + +2. **Select Module**: Choose a module from the selected category. + +3. **Enter Module Details**: + - **Title**: The title displayed above the module. If left blank, the module’s name will serve as the title. + - **Pane**: Select the content pane where the module will be placed, organized by modules in the pane. + - **Location**: Set the location of the module as "Top" or "Bottom" inside the pane . + - **Container**: Choose a theme container for the pane. + - **Visibility**: Options to set visibility as "Same As Page" or "Page Editors Only." + +### Add Existing Module + +This option allows you to select modules that are already present on other pages of your website: + +1. **Select Page**: A dropdown list of your other web pages from which you can select a page containing the desired module. +2. **Select Module**: A list of modules available on the selected page for you to choose from. + +### Copy Existing Module + +This option allows you to copy a module from another page: + +1. **Select Page**: A dropdown list of your other web pages from which you can select a page containing the desired module. +2. **Select Module**: A list of modules available on the selected page for you to choose from, allowing you to replicate functionality on your current page. + +When a module is selected, its description will appear in a purple box, providing clarity on its purpose. + +![Add Module Button](./assets/control-panel-add-module-to-page-button.png) + +--- diff --git a/src/pages/manuals/admin/content-management/page-management.md b/src/pages/manuals/admin/content-management/page-management.md index 1747af353..b87a06a14 100644 --- a/src/pages/manuals/admin/content-management/page-management.md +++ b/src/pages/manuals/admin/content-management/page-management.md @@ -2,7 +2,7 @@ The **Page Management** feature allows you to manipulate the page you are currently on by providing options for adding, editing, deleting, and publishing pages. This feature shares many capabilities with the admin dashboard's [Page Management feature](../admin-management/page-management.md), but is limited to changing the page you are currently managing. -![page management](./assets/control-panel-page-management.png) +![Control Panel Page Management](./assets/control-panel-page-management.png) ## Add @@ -32,7 +32,7 @@ ___ - **Head Content**: Optionally enter content to be included in the page head (ie. meta, link, or script tags) - **Body Content**: Optionally enter content to be included in the page body (ie. script tags) -![page management add settings](./assets/page-management-add-settings.png) +![Add Page Settings](./assets/page-management-add-settings.png) ___ @@ -111,4 +111,13 @@ To toggle the publish status, click the **Publish** button, which will switch be --- +--- + +## Creating an Admin Dashboard Page + +If you wish to add a custom page to the **Admin Dashboard**, you can do so through **Page Management** by setting the **Parent** page to "Admin" when adding a new page. This action designates the new page as part of the Admin Dashboard, making it accessible only to administrators. Creating admin-specific pages expands the available tools for site management and customizes the Admin Dashboard. + +For more information on extending the Admin Dashboard, refer to the [Admin Management documentation](../admin-management/index.md#extending-the-admin-dashboard). + + This detailed overview of the **Page Management** feature provides administrators with the essential tools to manage individual pages effectively. Each button feature is clearly defined to enhance user understanding and facilitate efficient page management. diff --git a/src/pages/manuals/admin/content-management/toc.yml b/src/pages/manuals/admin/content-management/toc.yml index 2273a7918..f5be00aa8 100644 --- a/src/pages/manuals/admin/content-management/toc.yml +++ b/src/pages/manuals/admin/content-management/toc.yml @@ -13,3 +13,6 @@ - name: Content Editor href: content-editor.md + +- name: HTML/Text Editor + href: html-text-editor.md \ No newline at end of file diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-event-log.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-event-log.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-event-log.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-event-log.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-language-management.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-language-management.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-language-management.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-language-management.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-module-management.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-module-management.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-module-management.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-module-management.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-scheduled-jobs.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-scheduled-jobs.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-scheduled-jobs.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-scheduled-jobs.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-site-management.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-site-management.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-site-management.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-site-management.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-site-settings.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-site-settings.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-site-settings.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-site-settings.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-sql-management.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-sql-management.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-sql-management.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-sql-management.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-system-info.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-system-info.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-system-info.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-system-info.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-system-update.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-system-update.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-system-update.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-system-update.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-theme-management.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-theme-management.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-theme-management.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-theme-management.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard-user-management.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard-user-management.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard-user-management.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard-user-management.png diff --git a/src/pages/manuals/admin/host-management/assets/host-admin-dashboard.png b/src/pages/manuals/admin/host-management/assets/admin-dashboard.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/host-admin-dashboard.png rename to src/pages/manuals/admin/host-management/assets/admin-dashboard.png diff --git a/src/pages/manuals/admin/host-management/assets/control-panel-admin-dashboard-button.png b/src/pages/manuals/admin/host-management/assets/control-panel-admin-dashboard-button.png new file mode 100644 index 000000000..89fe8ad9c Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/control-panel-admin-dashboard-button.png differ diff --git a/src/pages/manuals/admin/host-management/assets/control-panel-button.png b/src/pages/manuals/admin/host-management/assets/control-panel-button.png new file mode 100644 index 000000000..57ed13fb2 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/control-panel-button.png differ diff --git a/src/pages/manuals/admin/host-management/assets/event-log-settings-clear-events.png b/src/pages/manuals/admin/host-management/assets/event-log-settings-clear-events.png deleted file mode 100644 index 43a762417..000000000 Binary files a/src/pages/manuals/admin/host-management/assets/event-log-settings-clear-events.png and /dev/null differ diff --git a/src/pages/manuals/admin/host-management/assets/system-update-upload-upgrade-buttton.png b/src/pages/manuals/admin/host-management/assets/system-update-upload-upgrade-button.png similarity index 100% rename from src/pages/manuals/admin/host-management/assets/system-update-upload-upgrade-buttton.png rename to src/pages/manuals/admin/host-management/assets/system-update-upload-upgrade-button.png diff --git a/src/pages/manuals/admin/host-management/assets/system-update.png b/src/pages/manuals/admin/host-management/assets/system-update.png new file mode 100644 index 000000000..c200aba7c Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/system-update.png differ diff --git a/src/pages/manuals/admin/host-management/assets/theme-management-install-theme-marketplace.png b/src/pages/manuals/admin/host-management/assets/theme-management-install-theme-marketplace.png new file mode 100644 index 000000000..846e0c2f3 Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/theme-management-install-theme-marketplace.png differ diff --git a/src/pages/manuals/admin/host-management/assets/theme-management-install-theme-upload.png b/src/pages/manuals/admin/host-management/assets/theme-management-install-theme-upload.png new file mode 100644 index 000000000..5e0d3831b Binary files /dev/null and b/src/pages/manuals/admin/host-management/assets/theme-management-install-theme-upload.png differ diff --git a/src/pages/manuals/admin/installation/assets/appsettings-iis-location.png b/src/pages/manuals/admin/installation/assets/appsettings-iis-location.png new file mode 100644 index 000000000..70c1200c0 Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/appsettings-iis-location.png differ diff --git a/src/pages/manuals/admin/installation/assets/database-configuration-empty.png b/src/pages/manuals/admin/installation/assets/database-configuration-empty.png new file mode 100644 index 000000000..d3d59b95e Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/database-configuration-empty.png differ diff --git a/src/pages/manuals/admin/installation/assets/installation-wizard-application-administration.png b/src/pages/manuals/admin/installation/assets/installation-wizard-application-administration.png new file mode 100644 index 000000000..abc7aab65 Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/installation-wizard-application-administration.png differ diff --git a/src/pages/manuals/admin/installation/assets/installation-wizard-database-configuration.png b/src/pages/manuals/admin/installation/assets/installation-wizard-database-configuration.png new file mode 100644 index 000000000..7059786a6 Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/installation-wizard-database-configuration.png differ diff --git a/src/pages/manuals/admin/installation/assets/installation-wizard-install-button.png b/src/pages/manuals/admin/installation/assets/installation-wizard-install-button.png new file mode 100644 index 000000000..68aa0692e Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/installation-wizard-install-button.png differ diff --git a/src/pages/manuals/admin/installation/assets/installation-wizard-install-spinner.png b/src/pages/manuals/admin/installation/assets/installation-wizard-install-spinner.png new file mode 100644 index 000000000..64c34232f Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/installation-wizard-install-spinner.png differ diff --git a/src/pages/manuals/admin/installation/assets/installation-wizard.png b/src/pages/manuals/admin/installation/assets/installation-wizard.png new file mode 100644 index 000000000..3fa42f9d2 Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/installation-wizard.png differ diff --git a/src/pages/manuals/admin/installation/assets/login-button.png b/src/pages/manuals/admin/installation/assets/login-button.png new file mode 100644 index 000000000..d817d6536 Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/login-button.png differ diff --git a/src/pages/manuals/admin/installation/assets/login-host-user.png b/src/pages/manuals/admin/installation/assets/login-host-user.png new file mode 100644 index 000000000..f20333ad2 Binary files /dev/null and b/src/pages/manuals/admin/installation/assets/login-host-user.png differ diff --git a/src/pages/manuals/admin/installation/index.md b/src/pages/manuals/admin/installation/index.md index 4fd5f6d42..2e341a7dc 100644 --- a/src/pages/manuals/admin/installation/index.md +++ b/src/pages/manuals/admin/installation/index.md @@ -1,97 +1,44 @@ ---- -uid: Manuals.Installation.Index ---- +# Installation Introduction -# Installation +This manual introduces the **Installation Wizard** for Oqtane, focusing on setting up a core installation. The Installation Wizard streamlines the configuration of essential settings, including database connections and host account setup. -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. +## Installation Wizard Overview -## Download an Official Release +The **Installation Wizard** simplifies the setup process by guiding you through the following essential steps: -Find the official Oqtane releases on GitHub and follow these steps to download: +1. **Database Configuration** + - **Choose Database Provider**: Select a supported database (SQL Server, MySQL, PostgreSQL, SQLite). + - **Configure Connection String**: Ensure accurate server address, credentials, and database name. + - **Set Permissions**: The database user should have permissions for `CREATE`, `READ`, and `WRITE` operations. -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. +2. **Host and Admin Configuration** + - **Host Name**: Enter the primary domain or URL for accessing your Oqtane installation. + - **Admin Account**: Set up an admin user to access and manage your Oqtane installation after setup. -## Reset an Existing Oqtane Installation +3. **Finalize Installation** + - **Confirm Settings**: Verify and apply your configurations to complete setup. + - **Access the Site**: Redirect to the site homepage upon successful installation. -If you need to perform a clean database install for a previous version of Oqtane, follow these steps: +For an in-depth explanation of each screen and configuration in the wizard, refer to [Installation Wizard](installation-wizard.md). -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. +## Environment-Specific Recommendations ---- +For different deployment environments, such as production or development, consult the extended guides linked below. These provide more specific setup instructions, including handling permissions, optimizing server configurations, and other advanced considerations. -## Upgrade +> **Note**: Oqtane is optimized for Windows Server with IIS but also supports deployment on Linux (e.g., with NGINX or Apache). -Learn how to upgrade your existing Oqtane installation manually or through an automated process: +- [Installation Manuals](../../../manuals/installation/index.md): Detailed setup instructions for deploying Oqtane in different environments. -- [Upgrading Oqtane](upgrade.md): This section provides information on how to upgrade your existing Oqtane installation manually or through an automated process. +markdown ---- +## Additional Resources -## Development +For further insights on Oqtane installation and configuration, consider exploring these resources: -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. +- [GitHub Discussions](https://github.com/oqtane/oqtane.framework/discussions): Find community support and solutions for common installation questions. +- [Oqtane Blog - Installation Best Practices](https://www.oqtane.org/blog): Read about best practices and tips for a smooth installation process. +- [Community Wiki - Oqtane Setup](https://github.com/oqtane/oqtane.framework/wiki): Access community-contributed knowledge for specific setup scenarios and troubleshooting. -### 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 Administration Documentation Manuals Home Page](../index.md) +## See Also +For more comprehensive setup guidance, see the [Installation Manuals](../../../manuals/installation/index.md). diff --git a/src/pages/manuals/admin/installation/installation-wizard.md b/src/pages/manuals/admin/installation/installation-wizard.md new file mode 100644 index 000000000..f50c44850 --- /dev/null +++ b/src/pages/manuals/admin/installation/installation-wizard.md @@ -0,0 +1,81 @@ +# Installation Wizard + +The Oqtane Installation Wizard simplifies the setup process, guiding you through essential steps to configure and deploy your Oqtane instance. Follow the instructions in each step to ensure a smooth installation. + +## Getting Started with the Installation Wizard + +1. **Access the Installation Wizard**: + - Open your browser and navigate to the Oqtane application URL. If Oqtane is not yet configured, the wizard should load automatically. + - You should see a welcome screen prompting you to begin the setup process. + + ![Installation Wizard Start Screen](./assets/installation-wizard.png) + +2. **Database Configuration**: + - Select your preferred database type. Oqtane supports several database providers, such as SQL Server and SQLite. + - Enter the required database connection information, including the server, database name, and login credentials. + - The wizard will attempt to connect to your database to validate the information entered. + + ![Database Configuration Screen](./assets/installation-wizard-database-configuration.png) + + **Database Configuration Examples**: + - **SQL Server**: + - Server: `localhost` + - Database: `OqtaneDB` + - Authentication: SQL Server Authentication with a valid username and password + - **SQLite**: + - File Path: Specify a file path on the server where SQLite can create a new database file if it doesn’t exist. + +3. **Application Settings**: + - Define key site settings, including: + - Host Administrator Account: Specify a username, password, and email for the main site administrator. This user will be added to the "Host" permissions role, granting full access to [Content Management](../content-management/index.md), [Admin Management](../admin-management/index.md), and [Host Management](../host-management/index.md) features. + - Template: Select a site template. Oqtane provides options such as the "Default Site Template" or "Blank Template," and any additional site templates included with your setup will also be available. + + > **Note:** The current web address used to access the install wizard will be set as the default base URL or alias for your Oqtane site. + + ![Site Settings Screen](./assets/installation-wizard-application-configuration.png) + +4. **Complete Installation**: + - Review your configuration and click **Install**. The wizard will apply your settings, configure the database, and prepare your Oqtane instance for use. (Optionally, you can select a checkbox to receive product updates and security bulletins.) + + ![Installation Button](./assets/installation-wizard-install-button.png) + + - Upon completion, you’ll be redirected to the Oqtane homepage, where you can log in with the admin account created during setup. + + ![Installation Complete](./assets/installation-wizard-install-spinner.png) + + - Click the login button to access your site. + + ![Site Login](./assets/login-button.png) + + - Log in using the host account credentials you created. + + ![Login Host Account](./assets/installation-wizard-install-spinner.png) + + You now have full access to [Content Management](../content-management/index.md), [Admin Management](../admin-management/index.md), and [Host Management](../host-management/index.md) features. + +## Additional Tips + +- **Database Connection Issues**: If the wizard cannot connect to your database, double-check the server address, database name, and credentials. +- **File Permissions**: Ensure that your server has adequate permissions to write to necessary directories, such as for SQLite files or configuration files. +- **Re-running the Wizard**: To re-run the wizard after installation, delete the database connection string in the `appsettings.json` file located in the website's root folder or in the `Oqtane.Server` project. This will prompt Oqtane to load the installation wizard again upon your next visit to the application URL. + + - The `appsettings.json` file with an empty database connection string, as seen in Visual Studio: + + ![appsettings.json file - Visual Studio](./assets/database-configuration-empty.png) + + - The `appsettings.json` file location in the IIS root site folder: + + ![appsettings.json IIS Site File Location](./assets/appsettings-iis-location.png) + + +## Additional Resources + +For further insights on installation and troubleshooting, consider these resources: + +- [GitHub Discussions](https://github.com/oqtane/oqtane.framework/discussions): Find community support for common installation questions. +- [Oqtane Blog - Installation Tips](https://www.oqtane.org/blog): Read best practices and insights for a smooth installation. + +## See Also + +- [Installation Guides](../../../guides/installation/index.md): Comprehensive setup guidance and environment-specific tips. +- [Troubleshooting Installation Issues](troubleshooting.md): Solutions for common installation errors and setup challenges. diff --git a/src/pages/manuals/admin/installation/toc.yml b/src/pages/manuals/admin/installation/toc.yml index 6f0bf5bd6..b7cf4bb9a 100644 --- a/src/pages/manuals/admin/installation/toc.yml +++ b/src/pages/manuals/admin/installation/toc.yml @@ -1,40 +1,9 @@ -- name: Overview - href: index.md - -- 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: Introduction + href: index.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: Installation Wizard + href: installation-wizard.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 +- name: Introduction + href: troubleshooting.md \ No newline at end of file diff --git a/src/pages/manuals/admin/installation/troubleshooting.md b/src/pages/manuals/admin/installation/troubleshooting.md new file mode 100644 index 000000000..39904baf9 --- /dev/null +++ b/src/pages/manuals/admin/installation/troubleshooting.md @@ -0,0 +1,35 @@ +# Installation Troubleshooting + +The Installation Troubleshooting section provides solutions for common errors and challenges encountered during the installation of the Oqtane Framework. This guide aims to assist users in resolving issues efficiently, ensuring a smooth setup experience. + +## Common Installation Issues + +1. **Database Connection Problems**: + - If the installation wizard fails to connect to the database, check the following: + - Ensure the server address and database name are correctly entered. + - Verify that the database server is running and accessible. + - Confirm that the provided login credentials are valid and have the necessary permissions. + +2. **File Permission Errors**: + - If you encounter file permission issues, ensure that your web server has write access to the required directories. This is particularly important for: + - SQLite databases, where the server needs permission to create and modify database files. + - Configuration files that need to be updated during installation. + +3. **Re-running the Installation Wizard**: + - To re-run the installation wizard after an initial setup, remove the database connection string from the `appsettings.json` file. This file can typically be found in: + - The website's root folder or in the `Oqtane.Server` project in Visual Studio. + - Once the connection string is deleted, the installation wizard will prompt upon accessing the application URL. + +4. **Unexpected Errors**: + - If unexpected errors occur, refer to the server logs for detailed error messages. These logs can often provide insights into what went wrong during the installation process. + +## Additional Resources + +For more in-depth guidance, consider exploring the following resources: + +- [Installation Guides](../../../guides/installation/index.md): Comprehensive setup guidance and environment-specific tips to help you through the installation process. +- [Troubleshooting Installation Issues](troubleshooting.md): Detailed solutions for common installation errors and setup challenges, designed to assist both new and experienced users. +- [GitHub Discussions](https://github.com/oqtane/oqtane.framework/discussions): Engage with the Oqtane community to find solutions to common installation questions and share your experiences. +- [GitHub Issues](https://github.com/oqtane/oqtane.framework/issues): Report issues you encounter or check for existing issues related to installation problems. + +This section aims to streamline your installation experience by providing quick access to troubleshooting steps and resources. If you encounter any issues not covered in this guide, please refer to the community support channels for further assistance. diff --git a/src/pages/manuals/admin/marketplace/toc.yml b/src/pages/manuals/admin/marketplace/toc.yml deleted file mode 100644 index 299310aa8..000000000 --- a/src/pages/manuals/admin/marketplace/toc.yml +++ /dev/null @@ -1,14 +0,0 @@ -- name: Using the Oqtane Marketplace - href: using-oqtane-marketplace.md - -- name: Installing Modules - # href: installing-modules.md - -- name: Submitting Themes and Modules - # href: submitting-themes-modules.md - -- name: Monetization - href: ./monetization.md - -- name: Troubleshooting - href: troubleshooting.md