Skip to content

Commit

Permalink
More fixes (#89)
Browse files Browse the repository at this point in the history
* More fixes

* Delete src/pages/manuals/admin/admin-management/assets/file-management-folder-permission.png

it was nice in codespaces, it would do this for me, but this other way... i have to do it manually, or what am I doing wrong.?!

* Rename file-management-folder-permission.png to file-management-folder-permissions.png

* fixes links

* Update index.md

* Update modules.md

* Update troubleshooting.md

* Update troubleshooting.md

* Update troubleshooting.md

* Update troubleshooting.md

* Update troubleshooting.md

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update toc.yml

* Update troubleshooting.md

* Create index.md

* Create placeholder.md

* Create toc.yml

* Create troubleshooting.md

* Update troubleshooting.md

* Update toc.yml

* Create development-production-migration.md

* Create troubleshooting-migrations.md

* Update troubleshooting.md

* Update troubleshooting-migrations.md

* Update troubleshooting-developing-themes.md

* Update troubleshooting-developing-modules.md

* Update index.md

* Update toc.yml

* Update toc.yml

* Update index.md

* Update toc.yml

* Update toc.yml

* Update index.md

* Update toc.yml

* Update index.md
  • Loading branch information
thabaum authored Nov 7, 2024
1 parent f3348f5 commit dd688ea
Show file tree
Hide file tree
Showing 26 changed files with 678 additions and 63 deletions.
92 changes: 77 additions & 15 deletions src/pages/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,90 @@
uid: Guides.Index
---

# Guides WIP
# Welcome to the Oqtane Guides

![Oqtane Rocks!](../assets/logo.png)

This will probably become a main entry point to guide users through more complex topics.
Welcome to the **Oqtane Guides** page! This will be your entry point for exploring deeper and more complex topics related to Oqtane. Whether you're new or an experienced user, this page will help you navigate through various guides that cover installation, migration, extensions development, troubleshooting, and more.

> [!NOTE]
> This is a quick thing to get people started.
> This contents may be moved elsewhere
> This page is a work in progress. Some content may be moved to other sections as the documentation evolves.
## Current Guides
---

## 📚 Current Guides

Explore the guides listed below to get started with Oqtane. These will walk you through key concepts, installation steps, and advanced topics.

👉 **Select a guide from the menu** to dive in:

- **[Concepts](concepts/index.md)**
Learn the foundational concepts behind Oqtane's framework and architecture.

- **[Extensions Development](extensions/index.md)**
Develop your own extensions and modules for Oqtane. This guide provides everything from basics to advanced techniques.

- **[Installation](installation/index.md)**
Step-by-step guide to getting Oqtane set up in your environment. Covers system requirements, installation procedures, and first-time setup.

- **[Migration](migration/index.md)**
Instructions for migrating your Oqtane environment from development to production or between servers.

- **[Modules](modules/index.md)**
Learn how to work with modules, from installation to management and customization.

- **[Themes](themes/index.md)**
Customize the look and feel of your Oqtane application with theme development and troubleshooting.

- **[Marketplace](marketplace/index.md)**
Explore the Oqtane Marketplace, where you can find pre-built modules and extensions.

- **[Troubleshooting](troubleshooting/index.md)**
Solutions to common problems with installation, modules, themes, and user management.

---

## 🤝 Community Support

For help, discussions, or questions, reach out to our community:

👉 Select from the menu
- **[Oqtane Framework Discussions](https://github.com/oqtane/oqtane.framework/discussions)**
Join the discussion on GitHub for Oqtane Framework-specific queries and development-related conversations.

## External Guides / Valuable Articles
- **[Oqtane Docs Discussions](https://github.com/oqtane/oqtane.docs/discussions)**
Have questions about the documentation or need clarification on topics? Engage with the documentation community here.

- **[Join Our Discord](https://discord.gg/BnPny88avK)**
For more interactive discussions and real-time community support, join our [Discord server](https://discord.gg/BnPny88avK).

---

## 🔗 External Guides & Articles

Here are some external resources and articles that provide additional insights and advanced information for Oqtane developers:

- **[Oqtane Official Blog](https://www.oqtane.org/Blog)** – Stay updated with Oqtane announcements, news, and tips.
- **[Configuring the Blazor Oqtane Blog Module](https://blazorhelpwebsite.com/ViewBlogPost/15)** – A comprehensive guide to configuring and using the Blog module.
- **[Creating a Custom Distribution of Blazor Oqtane Using Site Templates](https://blazorhelpwebsite.com/ViewBlogPost/41)** – Learn how to create custom Blazor Oqtane distributions with site templates.
- **[Deploying Oqtane to Azure](https://blazorhelpwebsite.com/ViewBlogPost/40)** – Steps to deploy your Oqtane application on Microsoft Azure.
- **[Installing Blazor Oqtane](https://blazorhelpwebsite.com/ViewBlogPost/1)** – A step-by-step guide on installing Oqtane in a Blazor environment.
- **[Oqtane Module Creator](https://blazorhelpwebsite.com/ViewBlogPost/4)** – Learn how to create and manage custom modules in Oqtane.
- **[What is Blazor Oqtane?](https://blazorhelpwebsite.com/ViewBlogPost/16)** – An introduction to Blazor Oqtane and its features.

---

## 🚀 Next Steps

- Explore our **[Roadmap & History](roadmap/index.md)** for insights into the ongoing development of Oqtane.
- **Need help with documentation or contributing?** Visit our **[Documentation Page](docs/index.md)** to learn how you can get involved with contributing to Oqtane’s documentation and improving the guides.

---

> **Have questions or need support?**
> Feel free to reach out through our community channels for assistance!
---

Some helpful articles that are not part of the official documentation.
## 📣 Stay Updated

* [Oqtane Official Blog](https://www.oqtane.org/Blog)
* [BlazorHelpWebsite.com: Configuring The Blazor Oqtane Blog Module](https://blazorhelpwebsite.com/ViewBlogPost/15)
* [BlazorHelpWebsite.com: Creating a Custom Distribution of Blazor Oqtane Using Site Templates](https://blazorhelpwebsite.com/ViewBlogPost/41)
* [BlazorHelpWebsite.com: Oqtane Deploy to Azure](https://blazorhelpwebsite.com/ViewBlogPost/40)
* [BlazorHelpWebsite.com: Installing Blazor Oqtane](https://blazorhelpwebsite.com/ViewBlogPost/1)
* [BlazorHelpWebsite.com: Oqtane Module Creator](https://blazorhelpwebsite.com/ViewBlogPost/4)
* [BlazorHelpWebsite.com: What is Blazor Oqtane?](https://blazorhelpwebsite.com/ViewBlogPost/16)
For the latest updates on Oqtane, including new features, bug fixes, and community-driven developments, make sure to subscribe to our [official blog](https://www.oqtane.org/Blog).
4 changes: 2 additions & 2 deletions src/pages/guides/installation/maui-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Oqtane.Maui is a hybrid .NET MAUI application that integrates with the Oqtane fr

### 3. Edit the `MauiConstants.cs` File (Option #1)

1. Open your Oqtane.Maui project in Visual Studio. ![Oqtane.Maui Project Solution](maui-solution.png)
2. Locate the `MauiConstants.cs` file in your project directory. ![Oqtane.Maui Set MauiConstants.cs Url](maui-solution.png)
1. Open your Oqtane.Maui project in Visual Studio. ![Oqtane.Maui Project Solution](./assets/maui-solution.png)
2. Locate the `MauiConstants.cs` file in your project directory. ![Oqtane.Maui Set MauiConstants.cs Url](./assets/maui-set-url.png)
3. Modify the file to point to your Oqtane web application:

```csharp
Expand Down
2 changes: 1 addition & 1 deletion src/pages/guides/installation/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@
href: ./databases.md
- name: Installation Resources
href: ./resources.md
- name: Installation Troubleshooting
- name: Troubleshooting
href: ./troubleshooting.md
25 changes: 25 additions & 0 deletions src/pages/guides/installation/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Troubleshooting Installations

## Overview

This section provides resources and guidance for troubleshooting common installation issues in Oqtane. Whether you're setting up a fresh installation or addressing problems in an existing setup, these guides will help you resolve the most frequent installation challenges.

### Installation Troubleshooting Guides

Below are two detailed guides for troubleshooting installations, tailored to the specific needs of users and administrators:

- **[Installation Issues](../troubleshooting/troubleshooting-installations.md)**
This guide covers troubleshooting tips and solutions for common issues encountered during the installation process of Oqtane. It includes:
- **Installation Failures**: Steps to resolve issues when the installation does not complete successfully.
- **Database Connection Problems**: Solutions for troubleshooting database connection errors.
- **File Permission Issues**: Guidance on fixing file permission problems that may block the installation.
- **Configuration File Errors**: How to troubleshoot configuration file issues that prevent successful setup.

- **[Upgrading Installations](../troubleshooting/troubleshooting-upgrading-installations.md)**
This guide provides troubleshooting steps specifically for administrators upgrading their Oqtane installation. It addresses:
- **Upgrade Failures**: Identifying and resolving problems during the upgrade process.
- **Compatibility Issues**: Ensuring that the new version of Oqtane is compatible with your existing configuration.
- **Data Migration Problems**: Solutions for handling issues related to data migration during an upgrade.
- **Post-Upgrade Issues**: Resolving issues that arise after the upgrade is complete, such as broken links or missing data.

These guides are designed to provide practical solutions and best practices to help you install and upgrade Oqtane smoothly.
1 change: 1 addition & 0 deletions src/pages/guides/migrations/assets/placeholder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

51 changes: 51 additions & 0 deletions src/pages/guides/migrations/development-production-migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Migrating Oqtane Framework from Development to Production

## Overview

This guide provides step-by-step instructions for migrating an Oqtane Framework instance from a development environment to a production environment. It covers preparation steps, configuration adjustments, and troubleshooting tips to ensure a smooth migration and deployment.

### Steps for Migrating Oqtane from Development to Production

Follow the steps below to successfully migrate your Oqtane instance to a production environment:

#### 1. **Prepare the Development Environment for Migration**
- **Ensure All Features Are Tested**: Before migrating, thoroughly test all modules, features, and configurations in your development environment to ensure everything works as expected.
- **Backup Data and Configuration**: Take a backup of your development database, configuration files, and any custom content or themes you’ve created.
- **Check Version Compatibility**: Ensure that the Oqtane Framework version you're using in development is the same or compatible with the version you're installing in production.

#### 2. **Prepare the Production Environment**
- **Set Up the Production Server**: Install and configure all necessary components (e.g., web server, database, application server) in your production environment.
- **Set Appropriate File Permissions**: Ensure that your production environment has the correct file permissions, especially for uploads, logs, and configuration files.
- **Configure Security Settings**: Set up SSL certificates, configure firewalls, and ensure that production security best practices are in place.
- **Set Database Connection Strings**: Adjust the connection strings in your production environment to point to your production database server.

#### 3. **Deploy the Oqtane Framework to Production**
- **Deploy Files**: Copy all files from your development environment (including modules, themes, and content) to your production server.
- **Update Database**: If necessary, run any database migrations or schema updates required to bring the database in sync with the production environment.
- **Update Configuration Settings**: Modify any configuration settings (such as `appsettings.json`) to match the production environment, including things like logging levels, email settings, and application-specific parameters.

#### 4. **Testing in the Production Environment**
- **Verify the Application**: Once the migration is complete, thoroughly test the application in the production environment to ensure all features and functionalities work correctly.
- **Test Performance**: Ensure that performance is optimal by testing load times, page responses, and checking for bottlenecks.
- **Check Security Configurations**: Verify that SSL is enabled, authentication methods are working, and access control is enforced.

#### 5. **Go Live**
- **DNS Configuration**: Update your DNS settings to point to your production server.
- **Monitor the Application**: Use monitoring tools to track server performance, logs, and errors in the production environment.

### Troubleshooting Migration Issues

If you encounter issues during the migration, here are some common troubleshooting steps:

- **Configuration Mismatches**: Ensure that all environment-specific settings (such as database connection strings, file paths, and email settings) are updated in the production environment.
- **Missing Files**: Check that all necessary files from development (such as themes, modules, and content) were copied to the production server.
- **Permission Issues**: Ensure that your production environment has the correct file permissions for writing logs, caching, and other necessary operations.
- **Database Connectivity Issues**: Ensure the production server can connect to the production database and that the schema is up to date.
- **Broken Links or URLs**: Double-check any hardcoded URLs or references in configuration files that might be pointing to the development environment.

### Best Practices for Production Environments
- **Regular Backups**: Set up regular backups for your production database and files.
- **Logging and Monitoring**: Implement comprehensive logging and monitoring solutions for error tracking and performance metrics.
- **Scaling**: Ensure your production server is capable of handling the anticipated traffic, with the option to scale resources as needed.

This guide helps ensure that your Oqtane Framework instance is ready for production and that any migration issues can be efficiently resolved.
1 change: 1 addition & 0 deletions src/pages/guides/migrations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

8 changes: 8 additions & 0 deletions src/pages/guides/migrations/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- name: Introduction
href: index.md

- name: Development to Production Migrations
href: development-production-migration.md

- name: Troubleshooting
href: troubleshooting.md
22 changes: 22 additions & 0 deletions src/pages/guides/migrations/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Troubleshooting Migrations

## Overview

This section provides resources and guidance for troubleshooting common issues encountered during the migration of Oqtane instances. Whether you're migrating from an older version or moving Oqtane to a new environment, these guides will help you resolve common migration challenges.

### Migration Troubleshooting Guides

Below is a detailed guide for troubleshooting both migration and post-migration issues, tailored to the specific needs of users and administrators:

- **[Migration and Post-Migration Issues](../troubleshooting/troubleshooting-migrations.md)**
This guide covers troubleshooting tips and solutions for common issues encountered during the migration process of Oqtane, as well as problems that may arise after migration. Topics include:
- Migration failures
- Database migration problems
- Configuration errors
- File path and permission issues
- Missing data or modules
- Broken links or URLs
- Performance degradation
- User authentication problems

This guide is designed to provide practical solutions and best practices to help you complete and troubleshoot your Oqtane migration successfully.
6 changes: 3 additions & 3 deletions src/pages/guides/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ When you install Oqtane, the platform ships with a base set of modules already i

## 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).
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.

Expand All @@ -23,13 +23,13 @@ This is an example of a content pane.
- [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.
- [Troubleshooting Modules](../troubleshooting/troubleshooting-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.
- [Troubleshooting Module Development](../troubleshooting/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.
2 changes: 1 addition & 1 deletion src/pages/guides/modules/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,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-working-with-modules.md): Troubleshooting tips and solutions for common issues encountered with modules.
- [Troubleshooting Modules](../../guides/troubleshooting/troubleshooting-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.
7 changes: 3 additions & 4 deletions src/pages/guides/modules/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@
href: module-configuration.md
- name: Customizing Module Appearance
href: customizing-module-appearance.md
- name: Troubleshooting Modules
href: troubleshooting-modules.md

- name: Developing Modules
items:
Expand All @@ -24,5 +22,6 @@
href: module-development.md
- name: Module Deployment
href: module-deployment.md
- name: Troubleshooting Module Development
href: troubleshooting-module-development.md

- name: Troubleshooting
href: troubleshooting.mg
Loading

0 comments on commit dd688ea

Please sign in to comment.