Skip to content

Commit

Permalink
📝 Update documentation organization
Browse files Browse the repository at this point in the history
  • Loading branch information
@ujibang
ujibang committed Dec 7, 2023
1 parent 33f5af5 commit 520d3c2
Show file tree
Hide file tree
Showing 18 changed files with 1,522 additions and 1,165 deletions.
38 changes: 22 additions & 16 deletions _includes/docs-sidebar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ <h2>Overview</h2>
<li><a href="/docs">Overview</a></li>
<li><a href="/docs/faq">FAQ</a></li>
<li><a href="/docs/try">Try RESTHeart online</a></li>
<li><a href="/docs/ng-demo">A simple Angular demo</a></li>
<li><a href="/docs/mongodb-rest/tutorial">Data API Tutorial</a></li>
<li><a href="/docs/ng-demo">Simple Web App example</a></li>
<li><a href="/docs/mongodb-rest/tutorial">REST API Tutorial</a></li>
<li><a href="/docs/mongodb-graphql/tutorial">GraphQL API Tutorial</a></li>
<li><a href="/docs/performances">Performances</a></li>
<li><a href="/docs/tutorials">Blog posts</a></li>
<li><a href="/docs/video-tutorials">Video Tutorials</a></li>
Expand All @@ -23,7 +24,12 @@ <h2 class="mt-2">Setup</h2>
<li><a href="/docs/setup-with-docker">Setup with Docker</a></li>
<li><a href="/docs/configuration">Configuration</a></li>
<li><a href="/docs/default-configuration">Default Configuration</a></li>
<li><a href="/docs/security/how-clients-authenticate">Client Authentication Howto</a></li>
<li><a href="/docs/security/user-management">User Management</a></li>
<li><a href="/docs/graalvm"><strong>GraalVM</strong></a></li>
<li><a href="/docs/security/security-hardening"><strong>Security Hardening</strong></a></li>
<li><a href="/docs/security/tls">Configure TLS</a></li>
<li><a href="/docs/security/secure-connection-to-mongodb">Secure connection to MongoDB</a></li>
<li><a href="/docs/proxy">Proxying requests</a></li>
<li><a href="/docs/static-resources">Serving static resources</a></li>
<li><a href="/docs/logging">Logging</a></li>
Expand All @@ -37,39 +43,37 @@ <h2 class="mt-2">Setup</h2>
<h2 class="mt-2">Framework</h2>
</a>
<ul id="framework" class="collapse">
<!-- <li><a href="/docs/plugins/dev-env">Development Environment</a></li> -->
<li><a href="/docs/plugins/overview">Overview</a></li>
<li><a href="/docs/plugins/dev-env">Development Environment</a></li>
<li><a href="/docs/plugins/deploy">How to deploy Plugins</a></li>
<h3 id="rest-api" class="mt-2">Base Plugins</h2>
<li><a href="/docs/plugins/services">Services</a></li>
<li><a href="/docs/plugins/interceptors">Interceptors</a></li>
<li><a href="/docs/plugins/providers">Providers</a></li>
<li><a href="/docs/plugins/initializers">Initializers</a></li>
<li><a href="/docs/plugins/core-plugins-js">Services and Inteceptors in JavaScript</a></li>
<li><a href="/docs/plugins/security-plugins">Security Plugins</a></li>
<li><a href="/docs/plugins/cors">CORS</a></li>
<h3 id="rest-api" class="mt-2">Security Plugins</h2>
<li><a href="/docs/security/overview">Overview</a></li>
<li><a href="/docs/plugins/authentication-mechanisms">Authentication Mechanisms</a></li>
<li><a href="/docs/plugins/authenticators">Authenticators</a></li>
<li><a href="/docs/plugins/authorizers">Authorizers</a></li>
<li><a href="/docs/plugins/token-managers">Token Managers</a></li>
</ul>

<a data-toggle="collapse" href="#security" role="button" aria-expanded="false" aria-controls="collapseExample">
<h2 class="mt-2">Security</h2>
<h2 class="mt-2">Security Plugins</h2>
</a>
<ul id="security" class="collapse">
<li><a href="/docs/security/overview">Overview</a></li>
<li><a href="/docs/security/authentication">Authentication</a></li>
<li><a href="/docs/security/authorization">Authorization</a></li>
<li><a href="/docs/security/user-management">User Management</a></li>
<li><a href="/docs/security/how-clients-authenticate">How Clients Authenticate</a></li>
<li><a href="/docs/security/tls">Configure TLS</a></li>
<li><a href="/docs/security/secure-connection-to-mongodb">Secure connection to MongoDB</a></li>
<li><a href="/docs/security/other-security-plugins">Other Security Plugins</a></li>
<li><a href="/docs/security/security-hardening">Security Hardening</a></li>
</ul>

<a data-toggle="collapse" href="#mongodb" role="button" aria-expanded="false" aria-controls="collapseExample">
<h2 class="mt-2">MongoDB</h2>
<h2 class="mt-2">MongoDB Plugins</h2>
</a>
<ul id="mongodb" class="collapse">
<h3 id="rest-api" class="mt-2">REST API</h2>
<li><a href="/docs/mongodb-rest/tutorial">Tutorial</a></li>
<li><a href="/docs/mongodb-rest/read-docs">Read Documents</a></li>
<li><a href="/docs/mongodb-rest/write-docs">Write Documents</a></li>
<li><a href="/docs/mongodb-rest/files">Binary Files with GridFS</a></li>
Expand All @@ -90,12 +94,14 @@ <h3 id="rest-api" class="mt-2">REST API</h2>


<h3 id="rest-api" class="mt-2">GraphQL API</h3>
<li><a href="/docs/mongodb-graphql/">GraphQL Applications</a></li>
<li><a href="/docs/mongodb-graphql/">Overview</a></li>
<li><a href="/docs/mongodb-graphql/tutorial">Tutorial</a></li>
<li><a href="/docs/mongodb-graphql/graphql-apps">GraphQL App Definition</a></li>
<li><a href="/docs/mongodb-graphql/optimization">Optimization</a></li>
<li><a href="/docs/mongodb-graphql/example">Example</a></li>

<h3 id="rest-api" class="mt-2">Websocket API</h3>
<li><a href="/docs/mongodb-websocket/">Websocket API</a></li>
<li><a href="/docs/mongodb-websocket/">Overview</a></li>
<li><a href="/docs/mongodb-websocket/change-streams">Streams definition</a></li>
<li><a href="/docs/mongodb-websocket/variables">Variables</a></li>
<li><a href="/docs/mongodb-websocket/examples">Examples</a></li>
Expand Down
6 changes: 3 additions & 3 deletions css/asciidoctor.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-weight:300;font-s
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em;margin-bottom:16px}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
Expand Down Expand Up @@ -228,7 +228,7 @@ table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inh
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
.sidebarblock{border-style:solid;border-width:6px;border-color:var(--primarycolor);margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:8px;border-radius:8px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
Expand Down Expand Up @@ -403,7 +403,7 @@ dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1.2rem}
.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@media print{@page{margin:1.25cm .75cm}
Expand Down
Loading

0 comments on commit 520d3c2

Please sign in to comment.