Skip to content

Commit

Permalink
various markdown issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
@iJungleboy
iJungleboy committed Mar 25, 2024
1 parent 8bc2ca3 commit 4e08bec
Show file tree
Hide file tree
Showing 23 changed files with 495 additions and 192 deletions.
14 changes: 7 additions & 7 deletions docs/index.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/manuals/admin/installation/databases.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h3 id="linux-2">Linux</h3>
<ol>
<li><strong>Install PostgreSQL</strong>: On Ubuntu or your preferred Linux distribution, use the package manager to install PostgreSQL. Run the following command in the terminal:</li>
</ol>
<pre><code>sudo apt update
<pre><code class="lang-bash">sudo apt update
sudo apt install postgresql postgresql-contrib
</code></pre>
<ol start="2">
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/admin/installation/deploy-to-azure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h2 id="steps">Steps</h2>
<li>Once the deployment is complete, you can access your Oqtane application by visiting the URL of your Blazor Website Name. For example, if your Blazor Website Name is <code>my-oqtane-app</code>, then your URL would be <code>https://my-oqtane-app.azurewebsites.net/</code>.</li>
<li>Follow the installation wizard to set up your Oqtane application. You will need to enter the host email and password, and optionally once the installation process has completed you can set the site name, logo plus more in the administration dashboard site settings.</li>
</ol>
<h2 id="congratulations">Congratulations!</h2>
<h2 id="congratulations">Congratulations</h2>
<p>You have successfully deployed your Oqtane application on Azure. Enjoy! 😊</p>
<hr>
<h2 id="resources">Resources</h2>
Expand Down
13 changes: 7 additions & 6 deletions docs/manuals/admin/installation/development.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title> | Oqtane Docs - APIs and more for the Modular Blazor Application Framework </title>
<title>Install Oqtane for Visual Studio Development | Oqtane Docs - APIs and more for the Modular Blazor Application Framework </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content=" | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
<meta name="title" content="Install Oqtane for Visual Studio Development | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">

<link rel="icon" href="../../../layout/images/favicon.png">
<link rel="stylesheet" href="../../../public/docfx.min.css">
Expand Down Expand Up @@ -84,10 +84,11 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
</div>

<article data-uid="">
<h1 id="install-oqtane-for-visual-studio-development">Install Oqtane for Visual Studio Development</h1>

<h2 id="install-oqtane-for-visual-studio-development">Install Oqtane for Visual Studio Development</h2>
<h3 id="development-version-latest">Development Version (Latest)</h3>
<p>For general development and keeping up with the latest features, you can use the development branch of Oqtane Framework. However, for module development, it is recommended to target a stable release version of Oqtane Framework.</p>
<h2 id="development-version-latest">Development Version (Latest)</h2>
<p>For general development and keeping up with the latest features, you can use the development branch of Oqtane Framework.
However, for module development, it is recommended to target a stable release version of Oqtane Framework.</p>
<ol>
<li><p>Install <strong><a href="https://dotnet.microsoft.com/download/dotnet">Latest .NET SDK Release</a></strong>.</p>
</li>
Expand All @@ -109,7 +110,7 @@ <h3 id="development-version-latest">Development Version (Latest)</h3>
<li><p>Run the application.</p>
</li>
</ol>
<h3 id="release-and-legacy-development">Release and Legacy Development</h3>
<h2 id="release-and-legacy-development">Release and Legacy Development</h2>
<p>Below is a list of current and prior releases for module development targeting different frameworks.<br>
Check the official release page for any newer versions not listed.</p>
<h3 id="oqtane-version-5-net-8">Oqtane Version 5 (.net 8)</h3>
Expand Down
23 changes: 13 additions & 10 deletions docs/manuals/admin/installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ <h1 id="installation">Installation</h1>

<hr>
<h1 id="overview">Overview</h1>
<p>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.</p>
<p>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.</p>
<h2 id="downloading-an-official-release">Downloading an Official Release</h2>
<p>Find the official Oqtane releases on GitHub and follow these steps to download:</p>
<ol>
Expand All @@ -105,47 +108,47 @@ <h2 id="resetting-an-existing-oqtane-installation">Resetting an Existing Oqtane
<li>Run the application to trigger the re-installation process, which will execute the database installation scripts.</li>
</ol>
<hr>
<h1 id="upgrade">Upgrade</h1>
<h2 id="upgrade">Upgrade</h2>
<p>Learn how to upgrade your existing Oqtane installation manually or through an automated process:</p>
<ul>
<li><a href="upgrade.html">Upgrading Oqtane</a>: This section provides information on how to upgrade your existing Oqtane installation manually or through an automated process.</li>
</ul>
<hr>
<h1 id="development">Development</h1>
<h2 id="development">Development</h2>
<p>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.</p>
<h2 id="windows">Windows</h2>
<h3 id="windows">Windows</h3>
<ul>
<li><a href="development.html">Windows Visual Studio Development</a>: Install Oqtane quickly for development, primarily for Visual Studio and Windows development.</li>
<li><a href="development-vs-code.html">Windows Visual Studio Code Development</a>: Install Oqtane quickly for development, primarily for Visual Studio Code and Windows development.</li>
</ul>
<h2 id="linux">Linux</h2>
<h3 id="linux">Linux</h3>
<ul>
<li><a href="development-vs-code-linux.html">Linux Visual Studio Code Development</a>: Install Oqtane quickly for development, primarily for Visual Studio Code and Linux development.</li>
</ul>
<hr>
<h1 id="deploy">Deploy</h1>
<h2 id="deploy">Deploy</h2>
<p>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.</p>
<p>You can choose between the following deployment options:</p>
<h2 id="azure">Azure</h2>
<h3 id="azure">Azure</h3>
<p>Install Oqtane using the Deploy to Azure feature:</p>
<ul>
<li><a href="deploy-to-azure.html">Deploy Oqtane To Azure</a>: This guide shows you how to install Oqtane using the above Deploy To Azure feature.</li>
</ul>
<h2 id="windows-iis">Windows IIS</h2>
<h3 id="windows-iis">Windows IIS</h3>
<p>Install Oqtane with various configurations on Windows using IIS:</p>
<ul>
<li><a href="windows-iis-express-sql-express.html">Install Oqtane with IIS Express and SQL Express</a>: This guide shows you how to install Oqtane on Windows using IIS Express and SQL Express Server.</li>
<li><a href="windows-iis-localdb.html">Install Oqtane with IIS Express and LocalDB</a>: This guide shows you how to install Oqtane on Windows using IIS (Express) and LocalDb.</li>
<li><a href="windows-iis-sql.html">Install Oqtane with IIS and SQL Server</a>: This guide shows you how to install Oqtane on Windows using IIS and SQL Server.</li>
</ul>
<h2 id="linux-apache">Linux Apache</h2>
<h3 id="linux-apache">Linux Apache</h3>
<p>Install Oqtane with Apache on Linux (Ubuntu) with MySQL or PostgreSQL:</p>
<ul>
<li><a href="linux-ubuntu-apache-mysql.html">Install Oqtane with Apache and MySQL</a>: This guide shows you how to install Oqtane on Linux using Apache and MySQL.</li>
<li><a href="linux-ubuntu-apache-postgresql.html">Install Oqtane with Apache and PostgreSQL</a>: This guide shows you how to install Oqtane on Linux using Apache and PostgreSQL.</li>
</ul>
<hr>
<h1 id="resources">Resources</h1>
<h2 id="resources">Resources</h2>
<p>Explore additional installation resources and access the Oqtane blog and GitHub repository:</p>
<ul>
<li><a href="troubleshooting.html">Oqtane Installation Troubleshooting Tips</a>: If you encounter issues during the installation, upgrade, development, or deployment process, you can refer to our troubleshooting tips.</li>
Expand Down
22 changes: 9 additions & 13 deletions docs/manuals/admin/installation/linux-ubuntu-apache-mysql.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h1 id="installing-oqtane-using-ubuntu-desktop-apache-and-mysql-linux">Installin
<p><img src="../../../pages/manuals/admin/installation/assets/ubuntu-logo.png" alt="Ubuntu">
<img src="../../../pages/manuals/admin/installation/assets/apache-http-server-logo.png" alt="Apache HTTP Server">
<img src="../../../pages/manuals/admin/installation/assets/mysql-logo.png" alt="MySQL"></p>
<h1 id="step-1-install-ubuntu-desktop">Step 1: Install Ubuntu Desktop</h1>
<h2 id="step-1-install-ubuntu-desktop">Step 1: Install Ubuntu Desktop</h2>
<ol>
<li><p>Visit the <a href="https://ubuntu.com/download/desktop">Ubuntu Desktop download page</a> to download the latest version of Ubuntu Desktop.</p>
</li>
Expand All @@ -112,8 +112,7 @@ <h1 id="step-1-install-ubuntu-desktop">Step 1: Install Ubuntu Desktop</h1>
</ol>
<p>For more information on installing Ubuntu Desktop, refer to the <a href="https://ubuntu.com/tutorials/install-ubuntu-desktop#1-overview">official Ubuntu Desktop Installation Guide</a>.</p>
<p>For additional resources and documentation, visit the <a href="https://help.ubuntu.com/">Ubuntu documentation home page</a>.</p>
<h1 id="step-2-installing-mysql-database-on-ubuntu">Step 2: Installing MySQL Database on Ubuntu</h1>
<h2 id="overview">Overview</h2>
<h2 id="step-2-installing-mysql-database-on-ubuntu">Step 2: Installing MySQL Database on Ubuntu</h2>
<p>This guide provides detailed instructions on how to install and configure MySQL Database on Ubuntu. MySQL is a popular open-source relational database management system used by many applications and frameworks, including Oqtane Framework.</p>
<h3 id="prerequisites">Prerequisites</h3>
<ul>
Expand Down Expand Up @@ -220,14 +219,13 @@ <h3 id="step-7-create-oqtane-database">Step 7: Create Oqtane Database</h3>
</code></pre>
</li>
</ol>
<h1 id="step-3-install-apache-server">Step 3: Install Apache Server</h1>
<h2 id="overview-1">Overview</h2>
<h2 id="step-3-install-apache-server">Step 3: Install Apache Server</h2>
<p>This step covers the installation of Apache HTTP Server on Ubuntu. Apache is a widely-used web server that can serve HTML files and other content over HTTP.</p>
<h3 id="prerequisites-1">Prerequisites</h3>
<ul>
<li>Ubuntu Desktop or Server installed and configured on your system.</li>
</ul>
<h2 id="installation-process">Installation Process</h2>
<h3 id="installation-process">Installation Process</h3>
<ol>
<li><p><strong>Open Terminal</strong>:</p>
<ul>
Expand Down Expand Up @@ -280,14 +278,13 @@ <h3 id="additional-resources">Additional Resources</h3>
<li><a href="https://httpd.apache.org/docs/">Apache HTTP Server Documentation</a>: Official documentation for Apache HTTP Server.</li>
<li><a href="https://ubuntu.com/server/docs">Ubuntu Server Guide</a>: Comprehensive guide for Ubuntu Server, which includes instructions for installing and configuring various software packages.</li>
</ul>
<h1 id="step-4-install-net-core">Step 4: Install .NET Core</h1>
<h2 id="overview-2">Overview</h2>
<h2 id="step-4-install-net-core">Step 4: Install .NET Core</h2>
<p>This step covers the installation of .NET Core on Ubuntu. .NET Core is a cross-platform, open-source framework for building modern, cloud-based, and internet-connected applications.</p>
<h3 id="prerequisites-2">Prerequisites</h3>
<ul>
<li>Ubuntu Desktop or Server installed and configured on your system.</li>
</ul>
<h2 id="installation-process-1">Installation Process</h2>
<h3 id="installation-process-1">Installation Process</h3>
<ol>
<li><p><strong>Open Terminal</strong>:</p>
<ul>
Expand Down Expand Up @@ -332,8 +329,7 @@ <h3 id="additional-resources-1">Additional Resources</h3>
<li><a href="https://docs.microsoft.com/en-us/dotnet/">.NET Documentation</a>: Official documentation for .NET.</li>
<li><a href="https://dotnet.microsoft.com/download/dotnet">.NET Core Download Page</a>: Official download page for .NET Core SDK and runtime.</li>
</ul>
<h1 id="step-5-configure-host-and-service-files-for-apache">Step 5: Configure Host and Service Files for Apache</h1>
<h2 id="overview-3">Overview</h2>
<h2 id="step-5-configure-host-and-service-files-for-apache">Step 5: Configure Host and Service Files for Apache</h2>
<p>This step involves creating configuration files for Apache virtual host and service to serve your .NET Core application.</p>
<h3 id="prerequisites-3">Prerequisites</h3>
<ul>
Expand Down Expand Up @@ -404,7 +400,7 @@ <h3 id="additional-resources-2">Additional Resources</h3>
<li><a href="https://httpd.apache.org/docs/">Apache HTTP Server Documentation</a>: Official documentation for Apache HTTP Server.</li>
<li><a href="https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/">.NET Core Deployment Guide</a>: Official deployment guide for .NET Core applications.</li>
</ul>
<h1 id="step-6-setup-app-files-and-folders">Step 6: Setup App Files and Folders</h1>
<h2 id="step-6-setup-app-files-and-folders">Step 6: Setup App Files and Folders</h2>
<ol>
<li><p><strong>Create Directory Structure</strong>: Begin by creating a directory structure to organize your Oqtane application files. Choose a location on your Ubuntu system where you want to store the application files. For example:</p>
<pre><code class="lang-bash">sudo mkdir /var/www/oqtane
Expand Down Expand Up @@ -445,7 +441,7 @@ <h1 id="step-7-install-oqtane-framework-linux">Step 7: Install Oqtane Framework
<p>Configure Database Connection: Update the database connection string in the appsettings.json file located in the root directory of your Oqtane application. Use the connection string for your preferred database server (e.g., MySQL, PostgreSQL).</p>
<p>Access Oqtane Installation Wizard: Open a web browser and navigate to the URL associated with your Oqtane installation directory. If everything is configured correctly, you should see the Oqtane installation wizard, where you can proceed with the installation and setup of your Oqtane application.</p>
<p>By following these steps, you will have successfully installed and configured the Oqtane Framework on your Linux machine, making your application accessible via a web browser.</p>
<h1 id="step-8-test-the-installation">Step 8: Test the Installation</h1>
<h2 id="step-8-test-the-installation">Step 8: Test the Installation</h2>
<p>After completing the installation process, it's important to test your Oqtane application to ensure everything is working correctly. Follow these steps to test the installation:</p>
<ol>
<li><p><strong>Access Oqtane Application</strong>: Open a web browser and navigate to the URL associated with your Oqtane application. This should be the URL you configured during the installation process.</p>
Expand Down
Loading

0 comments on commit 4e08bec

Please sign in to comment.