Skip to content

Commit

Permalink
minor rebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
iJungleboy committed May 29, 2024
1 parent 27299f2 commit b458b22
Show file tree
Hide file tree
Showing 24 changed files with 479 additions and 55 deletions.
135 changes: 135 additions & 0 deletions docs/guides/concepts/404-page-behavior.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>404 Page Behavior | 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="404 Page Behavior | 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">
<link rel="stylesheet" href="../../public/main.css">
<meta name="docfx:navrel" content="../../toc.html">
<meta name="docfx:tocrel" content="../../pages/guides/toc.html">

<meta name="docfx:rel" content="../../">


<meta name="docfx:docurl" content="https://github.com/oqtane/oqtane.docs/blob/master/src/pages/guides/concepts/404-page-behavior.md/#L1">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
</head>

<script type="module" src="./../../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>


<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../layout/images/logo-white-50.png" alt="">

</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="">
<h1 id="404-page-behavior">404 Page Behavior</h1>

<p><img src="../../pages/guides/concepts/assets/404-not-found.png" alt="404 Page Example"></p>
<h2 id="issue-description">Issue Description</h2>
<p>This document aims to provide clarity on the behavior of the 404 page in the Oqtane Framework. It includes information on various scenarios where the 404 page is encountered and how it is handled within the framework.</p>
<h2 id="use-cases">Use Cases</h2>
<p>The 404 page is utilized in multiple scenarios within the Oqtane Framework:</p>
<ol>
<li><p><strong>Page Not Found</strong>: When a user requests a URL that does not correspond to any existing page in the site, and it has not been mapped using URL Mapping, the user is redirected to the 404 page.</p>
</li>
<li><p><strong>Unauthorized Access</strong>: If a user attempts to access a page for which they do not have permission, they are redirected to the 404 page instead of revealing the existence of the page.</p>
</li>
<li><p><strong>Effective Date and Expiry Date</strong>: If a page exists but the current date is outside the range specified by the Effective Date and Expiry Date, the user is directed to the 404 page.</p>
</li>
</ol>
<h2 id="framework-behavior">Framework Behavior</h2>
<p>In the Oqtane Framework, the term &quot;404&quot; refers to the friendly page that users are redirected to when the framework is unable to navigate them to the requested URL. This page has a path of &quot;/404&quot;.</p>
<p>Regarding permissions, there has been debate about whether to strictly adhere to HTTP status codes or to prioritize security by not revealing the existence of pages to unauthorized users. As of now, Oqtane has opted for a single &quot;friendly&quot; page for handling these scenarios.</p>
<h2 id="reference">Reference</h2>
<p>For more details and discussions on this topic, refer to <a href="https://github.com/oqtane/oqtane.framework/issues/4088">issue #4088</a> in the Oqtane Framework repository.</p>
<h2 id="conclusion">Conclusion</h2>
<p>By understanding the behavior of the 404 page in the Oqtane Framework, administrators can better manage and customize the user experience when encountering non-existent or unauthorized URLs.</p>

</article>

<div class="contribution d-print-none">
<a href="https://github.com/oqtane/oqtane.docs/blob/master/src/pages/guides/concepts/404-page-behavior.md/#L1" class="edit-link">Edit this page</a>
</div>

<div class="next-article d-print-none border-top" id="nextArticle"></div>

</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>

<div class="container-xxl search-results" id="search-results"></div>

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/guides/docs/markdown.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Markdown Tips in the Octane Docs | Oqtane Docs - APIs and more for the Modular Blazor Application Framework </title>
<title>Markdown Tips in the Oqtane Docs | 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="Markdown Tips in the Octane Docs | Oqtane Docs - APIs and more for the Modular Blazor Application Framework ">
<meta name="title" content="Markdown Tips in the Oqtane Docs | 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,7 +84,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
</div>

<article data-uid="">
<h1 id="markdown-tips-in-the-octane-docs">Markdown Tips in the Octane Docs</h1>
<h1 id="markdown-tips-in-the-oqtane-docs">Markdown Tips in the Oqtane Docs</h1>

<p>Refer to <a href="http://daringfireball.net/projects/markdown/">Markdown</a> for how to write markdown files. Here the most important tips for people working with this:</p>
<h2 id="links">Links</h2>
Expand Down
14 changes: 12 additions & 2 deletions docs/index.json

Large diffs are not rendered by default.

110 changes: 110 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -4093,6 +4093,26 @@
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "pages/guides/concepts/404-page-behavior.md",
"output": {
".html": {
"relative_path": "guides/concepts/404-page-behavior.html"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/guides/concepts/assets/404-not-found.png",
"output": {
"resource": {
"relative_path": "pages/guides/concepts/assets/404-not-found.png"
}
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "pages/guides/concepts/dll-handling.md",
Expand Down Expand Up @@ -4981,6 +5001,16 @@
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/admin-dashboard-site-settings.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/apache-http-server-logo.png",
Expand All @@ -4991,6 +5021,16 @@
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/control-panel-admin-dashboard.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/linux-logo.png",
Expand All @@ -5001,6 +5041,46 @@
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/maui-run-windows-machine.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/maui-run-windows-machine.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/maui-set-local-development-url.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/maui-set-local-development-url.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/maui-set-url.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/maui-set-url.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/maui-solution.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/maui-solution.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/microsoft-azure-logo.png",
Expand Down Expand Up @@ -5081,6 +5161,16 @@
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/site-settings-ui-component-settings-hybrid-enabled.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/sqlite-logo.png",
Expand Down Expand Up @@ -5111,6 +5201,16 @@
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/user-management-token-settings.png",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/assets/user-management-token-settings.png"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/assets/visual-studio-logo.jpg",
Expand Down Expand Up @@ -5241,6 +5341,16 @@
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "pages/manuals/admin/installation/maui-setup.md",
"output": {
".html": {
"relative_path": "manuals/admin/installation/maui-setup.html"
}
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "pages/manuals/admin/installation/resources.md",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h2 id="prerequisites">Prerequisites</h2>
<ul>
<li>A <a href="https://ubuntu.com/download/desktop">Linux Ubuntu</a> machine with internet access and administrator privileges.</li>
<li><a href="https://dotnet.microsoft.com/download/dotnet">.NET SDK</a> installed on your machine.</li>
<li>A <a href="installation/databases.md">database server</a> installed on your machine or accessible from your network. You can use MySQL, PostgreSQL, SQLite, or SQL Server.</li>
<li>A <a href="databases.html">database server</a> installed on your machine or accessible from your network. You can use MySQL, PostgreSQL, SQLite, or SQL Server.</li>
</ul>
<h2 id="steps">Steps</h2>
<ol>
Expand Down
1 change: 0 additions & 1 deletion docs/manuals/admin/installation/development-vs-code.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ <h2 id="resources">Resources</h2>
<li><a href="https://github.com/oqtane/oqtane.framework">Oqtane Framework GitHub Repository</a></li>
<li><a href="https://code.visualstudio.com">Visual Studio Code</a></li>
<li><a href="https://dotnet.microsoft.com">.NET Core</a></li>
<li></li>
</ul>
<h2 id="related-pages">Related Pages</h2>
<ul>
Expand Down
Loading

0 comments on commit b458b22

Please sign in to comment.