5.2.4 Documentation Update (#80)

* Update to 5.2.4

* Create search-settings.md

* adds administration search settings images

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

* Adds images and manual to get to search features

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

* Adds search reindex button information

* Adds search reindex button image

* Adds Search Settings TOC

* fix image link for reindex

* Update search-settings.md

* Create url-management.md

* Create language-management.md

* Adds Administrator Dashboard Images

* Create visitor-management.md

* Update toc.yml to add missing pages

* Create access-control-panel.md

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

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

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

* Adds urls mapped images

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

* Add files via upload

* Update url-mappings.md

* Add files via upload

* Update url-mappings.md

* Update url-mappings.md

* Update visitor-management.md

* Update visitor-management.md

* Update visitor-management.md

* Update visitor-management.md

* Add Visitor Management Images

* Update language-management.md

* Adds Language Management Images

* Update language-management.md

* Add files via upload

* Update language-management.md

* Update language-management.md

* Adds language management search image

* Update language-management.md

* Update language-management.md

* Update User Manuals toc.yml

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

* Rename index.md to index.md

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

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

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

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

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

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

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

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

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

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

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

* Rename toc.yml to toc.yml

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

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

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

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

* Rename index.md to index.md

* Rename toc.yml to toc.yml

* Rename modules.md to modules.md

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

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

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

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

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

* Rename index.md to index.md

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

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

* Rename toc.yml to toc.yml

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Rename permissions.png to permissions.png

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

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

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

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

* Add files via upload

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Rename index.md to control-panel.md

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

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

* Update toc.yml

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

* Update control-panel.md

* Update toc.yml

* Update toc.yml

* Update index.md

* Update index.md

* Update index.md

* Update toc.yml

* Update toc.yml

* Update index.md

* Adds Admin Management For Oqtane 5.2.4 Images

* Adds Host Management Images For Oqtane 5.2.4

* Adds Content Management Images For Oqtane 5.2.4

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

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

* Adds 5.2.4 Host Management Image Assets

* Create Installation Guide index.md

* Create installation guilde toc.yml

* Create index.md

* Create Modules toc.yml

* Create index.md

* Create toc.yml

* Create Troubleshooting Guides index.md

* Create toc.yml

* Update Guides toc.yml

- adds installation, modules, troubleshooting and marketplace

* Update troubleshooting guide index.md

* Update toc.yml

* Create troubleshooting-login-issues.md

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

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

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update index.md

* Update index.md

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

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

* Move to modules guides

* Fix Move creating-a-module.md

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

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

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

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

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

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

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

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

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

* Rename index.md to modules.md

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

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

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

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

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

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

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

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

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

* Rename troubleshooting.md to troubleshooting-themes.md

* Update index.md

* Update index.md

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

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

* Rename index1.md to index.md

* Rename monetization.md to monetization.md

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

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

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

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

* Update toc.yml

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

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

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

* Update page-management.md

* Update page-management.md

* Update page-management.md

src/index.md

@@ -1,4 +1,4 @@
-# Oqtane Documentation 5.1.2
+# Oqtane Documentation 5.2.4
 
 > Oqtane is _the_ **Modular Application Framework for Blazor**
 >

src/pages/guides/docs/toc.yml

@@ -1,4 +1,7 @@
 
+- name: Introduction
+  href: index.md
+
 - name: Get Started
   href: build.md
   items:

src/pages/guides/extensions/toc.yml

@@ -1,5 +1,5 @@
 
-- name: Extension Development Guide
+- name: Introduction
   href: index.md
 
 - name: Build and Deploy
@@ -19,4 +19,4 @@
   - name: Separate Solutions for Your Extensions
     href: best-practices/create-solutions-for-each-extension.md
   - name: Use Nuget for Oqtane Dependencies
-    href: best-practices/use-nuget-for-dependencies.md
+    href: best-practices/use-nuget-for-dependencies.md

src/pages/guides/installation/index.md

@@ -0,0 +1 @@
+# Installation Guide

src/pages/manuals/admin/marketplace/index.md → src/pages/guides/marketplace/index.md

@@ -1,4 +1,6 @@
-# Oqtane Marketplace Overview
+# Oqtane Marketplace
+
+## Introduction
 
 The Oqtane Marketplace is a central hub where users and developers can discover,
 share, and distribute themes, modules, and translations for the Oqtane framework.

src/pages/guides/marketplace/toc.yml

@@ -0,0 +1 @@
+

src/pages/guides/modules/index.md

@@ -0,0 +1 @@
+# Module Development Guides

src/pages/guides/modules/toc.yml

@@ -0,0 +1 @@
+

src/pages/guides/themes/assets/placeholder.md

@@ -0,0 +1 @@
+

src/pages/guides/themes/toc.yml

@@ -1,5 +1,5 @@
 
-- name: Oqtane Themes Guide
+- name: Introduction
   href: index.md
 
 - name: Parts of an Oqtane Theme
@@ -15,4 +15,4 @@
   href: oqtane-theme-code-explained.md
 
 - name: Theme Solution Explained
-  href: oqtane-theme-solution-explained.md
+  href: oqtane-theme-solution-explained.md

src/pages/guides/toc.yml

@@ -11,10 +11,30 @@
   topicUid: Guides.Extensions.Index
   # topicHref: dev/index.md
 
+- name: Installation
+  href: installation/toc.yml
+  topicHref: installation/index.md
+  # href: installation/index.md
+
+- name: Modules
+  href: modules/toc.yml
+  topicHref: modules/index.md
+  # href: modules/index.md
+
 - name: Themes
   href: themes/toc.yml
   topicHref: themes/index.md
   # href: themes/index.md
+
+- name: Marketplace
+  href: marketplace/toc.yml
+  topicHref: marketplace/index.md
+  # href: marketplace/index.md
+
+- name: Troubleshooting
+  href: troubleshooting/toc.yml
+  topicHref: troubleshooting/index.md
+  # href: troubleshooting/index.md
 
 - name: Roadmap & History
   topicUid: Guides.Roadmap.Index
@@ -24,4 +44,4 @@
 - name: Documentation
   # topicUid: Article.Docs.Index
   href: docs/toc.yml
-  topicHref: docs/index.md
+  topicHref: docs/index.md

src/pages/guides/troubleshooting/index.md

@@ -0,0 +1,47 @@
+---
+uid: Guides.Troubleshooting.Index
+---
+
+# Troubleshooting Guide
+
+## Introduction
+
+This document provides troubleshooting tips for common issues encountered in the Oqtane Framework.
+
+## What is the Oqtane Troubleshooting Guide?
+
+The Oqtane Troubleshooting Guide aims to assist users in resolving common problems related to login issues, user registration, system upgrades, and more. It serves as a comprehensive resource for both administrators and users facing challenges within the Oqtane Framework.
+
+## Next Steps
+
+Read about:
+
+- [Troubleshooting Login Issues](troubleshooting-login-issues.md)
+-  [Troubleshooting User Registration Email Verification](troubleshooting-user-registration-email-verification.md)
+- [Installation Troubleshooting](troubleshooting-installation.md)  
+   Instructions for resolving installation problems and verifying system requirements.
+- [Marketplace Troubleshooting](troubleshooting-marketplace.md)  
+  Solutions for common challenges encountered in the Oqtane Marketplace.
+- [Modules Troubleshooting](troubleshooting-modules.md)  
+   Guidance on resolving issues with module installation, compatibility, and functionality.
+- [Themes Troubleshooting](troubleshooting-themes.md)  
+   Tips for addressing layout, styling, and rendering issues in Oqtane themes.
+
+## Tasks to Complete
+
+The following topics should be covered to enhance the troubleshooting guide:
+
+1. Common login issues and their resolutions.
+2. Registration verification steps and user management.
+3. Best practices for maintaining SSL certificates.
+4. Guidance on handling SMTP issues.
+5. Common problems during upgrades and their resolutions.
+6. **Migration Troubleshooting:** Steps for migrating environments, such as from development to production or server-to-server.
+7. Data loss or corruption issues during migrations.
+8. Troubleshooting installation failures and checking system requirements.
+9. Resolving configuration issues post-installation.
+10. Identifying and addressing performance bottlenecks.
+11. Managing dependencies and troubleshooting related issues.
+12. Troubleshooting user permissions and role management.
+13. Common database-related problems and recovery steps.
+14. Enabling and configuring logging for troubleshooting.

src/pages/guides/troubleshooting/toc.yml

@@ -0,0 +1,21 @@
+
+- name: Introduction
+  href: index.md
+
+- name: Troubleshooting Installations
+  href: troubleshooting-installations.md
+
+- name: Troubleshooting Modules
+  href: troubleshooting-modules.md
+
+- name: Troubleshooting Themes
+  href: troubleshooting-themes.md
+
+- name: Troubleshooting Marketplace
+  href: troubleshooting-modules.md
+
+- name: Troubleshooting Login Issues
+  href: troubleshooting-login-issues.md
+
+- name: Troubleshooting User Registration Email Verification
+  href: troubleshooting-user-registration-email-verification.md

src/pages/guides/troubleshooting/troubleshooting-login-issues.md

@@ -0,0 +1,29 @@
+# Troubleshooting Login Issues
+
+## Issue: Unable to log into a production website.
+
+**Potential Cause:** An expired or improperly configured SSL certificate, or cookie issues.
+
+### Resolution Steps:
+
+1. **Check SSL Certificate:**
+   - Verify if the SSL certificate for the website is expired. You can check this by clicking on the padlock icon in the browser's address bar, which will display certificate details.
+   - If the certificate is expired, you will need to renew it through your certificate authority (CA).
+
+2. **Validate SSL Configuration:**
+   - Ensure that the SSL certificate is correctly installed and configured on the web server. Misconfigurations can lead to failed login attempts.
+   - Use online tools (like SSL Labs) to test the SSL configuration and identify any issues.
+
+3. **Update Certificate:**
+   - If the certificate is not properly set up, re-install or configure the certificate as per the guidelines provided by your CA or hosting provider.
+
+4. **Refresh the Page:**
+   - Refresh the login page to ensure that any changes to cookies are reflected. This helps prevent logging in with an old cookie name that may no longer be valid. Use the following quick keys based on your browser:
+     - **Google Chrome / Firefox / Edge:** `F5` or `Ctrl + R`
+     - **Safari (macOS):** `Command + R`
+     - **Internet Explorer:** `F5` or `Ctrl + F5` (to refresh and bypass cache)
+
+5. **Test Login Again:**
+   - After resolving any SSL or cookie issues, attempt to log in to the website again.
+
+

src/pages/guides/troubleshooting/troubleshooting-user-registration-email-verification.md

@@ -0,0 +1,24 @@
+# Troubleshooting User Registration Email Verification
+
+## Issue: A user registers but is unable to verify their account.
+
+**Potential Cause:** SMTP server issues or email lost in junk mail.
+
+### Resolution Steps:
+
+1. **Manually Update Email Confirmation:**
+   - If you know the user and trust their registration, you can manually update the `EmailConfirmed` field in the `AspNetUsers` database to `true`. This will allow the user to log in without verifying their email address.
+   - Execute an SQL command similar to the following:
+     ```sql
+     UPDATE AspNetUsers SET EmailConfirmed = `True` WHERE Email = '[email protected]';
+     ```
+   - Replace `[email protected]` with the actual email address of the user.
+
+2. **Check Email Configuration:**
+   - Ensure that your SMTP server is correctly configured. Check the SMTP settings in your application to confirm that emails can be sent.
+
+3. **Consider Deleting the User:**
+   - If the SMTP issue has been resolved, you may consider deleting the user and asking them to register again. This can help ensure that the user receives the verification email correctly.
+
+4. **Feature Request:**
+   - A feature request to add an administrative function for confirming the email addresses of self-registered users has been made. You can track the progress of this request [here](https://github.com/oqtane/oqtane.framework/issues/4789). If accepted and a contribution is made, this feature may be included in version 6.0.0 or later.

src/pages/manuals/admin/admin-dashboard/index.md → src/pages/manuals/admin/admin-management/index.md

@@ -1,4 +1,4 @@
-# Admin Dashboard
+# 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.
 

src/pages/manuals/admin/admin-management/language-management.md

@@ -0,0 +1,80 @@
+# Language Management
+
+![Language Management Feature](assets/language-management.png)
+
+This document describes the Language Management module, settings, and configuration for administrators to manage language resources effectively across their Oqtane site.
+
+## Overview
+
+The **Language Management** feature allows administrators to manage translations for their site, ensuring that the site content is available in multiple languages, enhancing accessibility and user experience.
+
+---
+
+## Control Panel Walkthrough
+
+### Accessing the Language Management Feature
+
+1. Click the control panel icon to access additional settings.
+
+   ![Control Panel Icon](assets/control-panel-button.jpg)
+
+2. In the control panel, select the button to open the admin dashboard.
+
+   ![Open Admin Dashboard](assets/control-panel-admin-dashboard-button.jpg)
+
+3. In the admin dashboard, click on the Language Management icon to configure your language resources.
+
+   ![Admin Dashboard Language Management](assets/admin-dashboard-language-management.jpg)
+
+---
+
+## Configuring Language Management
+
+Once in the Language Management settings, administrators can view and manage language resources.
+
+### Main Index Page
+
+The **Language Management** main index page displays all installed languages.
+
+![Language Management Index Page](assets/language-management-list.png)
+
+1. The list includes the name of each language, along with options to edit or delete (except for the default English language).
+
+   ![Edit/Delete Buttons](assets/language-management-edit-delete-buttons.png)
+
+### Adding a Language
+
+1. Use the **Add Language** button to open a popup modal for adding a new language.
+
+   ![Add Language Popup](assets/language-management-add-language.png)
+
+   - In the popup, select the language by name and set it as default using the Yes/No dropdown options.
+
+   ![Add Language Settings](assets/language-management-add-language-settings.png)
+
+### Searching Languages
+
+The search feature allows administrators to filter through installed languages, which is particularly helpful when many languages are available.
+
+![Language Management Index Page](assets/language-management-search.png)
+
+### Reviewing and Editing Languages
+
+1. To edit an existing language, click the **Edit** button next to the desired language.
+
+   ![Edit/Delete Buttons](assets/language-management-edit-delete-buttons.png)
+
+2. This will open the edit popup, where you can modify the language settings.
+
+   ![Edit Language Popup](assets/language-management-edit-settings.png)
+
+   - You can set the language as default using the Yes/No dropdown option.
+
+3. To delete a language, click the **Delete** button next to the language. Note that the default English language cannot be deleted.
+
+
+---
+
+## Conclusion
+
+The Language Management module in Oqtane provides an effective way for administrators to manage language resources and translations. By leveraging the features outlined in this manual, site administrators can enhance user experience and ensure their content is accessible in multiple languages.