Skip to content

Commit

Permalink
✨ RESTHeart v8
Browse files Browse the repository at this point in the history
  • Loading branch information
@ujibang
ujibang committed May 21, 2024
1 parent 9f6e91a commit b0d6c04
Show file tree
Hide file tree
Showing 83 changed files with 14,396 additions and 23 deletions.
9 changes: 7 additions & 2 deletions _config.yml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: RESTHeart - Ready to use backend for Web and Mobile Apps
title: RESTHeart - Virtual Threads Powered API Framework
timezone: Europe/Rome
collections:
posts:
Expand Down Expand Up @@ -28,9 +28,14 @@ defaults:
docs_version: 6
sitemap: false
- scope:
path: docs
path: docs/v7
values:
docs_version: 7
sitemap: false
- scope:
path: docs
values:
docs_version: 8
encoding: UTF-8
email: [email protected]
description: Low code API Framework for MongoDB
Expand Down
4 changes: 2 additions & 2 deletions _includes/docs-sidebar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
<h2>Overview</h2>
</a>
<ul id="overview" class="collapse">
<li><a href="/docs/upgrade-to-v8"><strong>Upgrade to v8</strong></a></li>
<li><a href="/docs">Overview</a></li>
<li><a href="/docs/faq">FAQ</a></li>
<li><a href="https://github.com/SoftInstigate/restheart/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22">Roadmap</a></li>
<li><a href="/docs/plugins/tutorial">Framework Tutorial</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>
Expand All @@ -13,8 +15,6 @@ <h2>Overview</h2>
<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>
<li><a href="/docs/upgrade-to-v7"><strong>Upgrade to v7</strong></a></li>
<li><a href="https://github.com/SoftInstigate/restheart/discussions/425">Roadmap</a></li>
</ul>

<a data-toggle="collapse" href="#setup" role="button" aria-expanded="false" aria-controls="collapseExample">
Expand Down
128 changes: 128 additions & 0 deletions _includes/docs-v7-sidebar.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@

<a data-toggle="collapse" href="#overview" role="button" aria-expanded="false" aria-controls="collapseExample">
<h2>Overview</h2>
</a>
<ul id="overview" class="collapse">
<li><a href="/docs/v7">Overview</a></li>
<li><a href="/docs/v7/faq">FAQ</a></li>
<li><a href="/docs/v7/plugins/tutorial">Framework Tutorial</a></li>
<li><a href="/docs/v7/mongodb-rest/tutorial">REST API Tutorial</a></li>
<li><a href="/docs/v7/mongodb-graphql/tutorial">GraphQL API Tutorial</a></li>
<li><a href="/docs/v7/security/tutorial">Auth^2 Tutorial</a></li>
<li><a href="/docs/v7/example-webapps">Example Web Apps built with RESTHeart</a></li>
<li><a href="/docs/v7/performances">Performances</a></li>
<li><a href="/docs/v7/tutorials">Blog posts</a></li>
<li><a href="/docs/v7/video-tutorials">Video Tutorials</a></li>
<li><a href="/docs/v7/upgrade-to-v7"><strong>Upgrade to v7</strong></a></li>
<li><a href="https://github.com/SoftInstigate/restheart/discussions/425">Roadmap</a></li>
</ul>

<a data-toggle="collapse" href="#setup" role="button" aria-expanded="false" aria-controls="collapseExample">
<h2 class="mt-2">Setup</h2>
</a>
<ul id="setup" class="collapse">
<li><a href="/docs/v7/setup"><strong>Setup</strong></a></li>
<li><a href="/docs/v7/setup-with-docker">Setup with Docker</a></li>
<li><a href="/docs/v7/configuration">Configuration</a></li>
<li><a href="/docs/v7/default-configuration">Default Configuration</a></li>
<li><a href="/docs/v7/security/how-clients-authenticate">Client Authentication Howto</a></li>
<li><a href="/docs/v7/security/user-management">User Management</a></li>
<li><a href="/docs/v7/graalvm"><strong>GraalVM</strong></a></li>
<li><a href="/docs/v7/security/security-hardening"><strong>Security Hardening</strong></a></li>
<li><a href="/docs/v7/security/tls">Configure TLS</a></li>
<li><a href="/docs/v7/security/secure-connection-to-mongodb">Secure connection to MongoDB</a></li>
<li><a href="/docs/v7/proxy">Proxying requests</a></li>
<li><a href="/docs/v7/static-resources">Serving static resources</a></li>
<li><a href="/docs/v7/logging">Logging</a></li>
<li><a href="/docs/v7/monitoring">Monitoring</a></li>
<li><a href="/docs/v7/auditing">Auditing</a></li>
<li><a href="/docs/v7/clustering">Clustering &amp; Load Balancing</a></li>
<li><a href="/docs/v7/enterprise-license">Enterprise License</a></li>
</ul>

<a data-toggle="collapse" href="#framework" role="button" aria-expanded="false" aria-controls="collapseExample">
<h2 class="mt-2">Framework</h2>
</a>
<ul id="framework" class="collapse">
<!-- <li><a href="/docs/v7/plugins/dev-env">Development Environment</a></li> -->
<li><a href="/docs/v7/plugins/overview">Overview</a></li>
<li><a href="/docs/v7/plugins/tutorial">Tutorial</a></li>
<li><a href="/docs/v7/plugins/deploy">How to deploy Plugins</a></li>
<h3 id="rest-api" class="mt-2">Base Plugins</h2>
<li><a href="/docs/v7/plugins/services">Services</a></li>
<li><a href="/docs/v7/plugins/interceptors">Interceptors</a></li>
<li><a href="/docs/v7/plugins/providers">Providers</a></li>
<li><a href="/docs/v7/plugins/initializers">Initializers</a></li>
<li><a href="/docs/v7/plugins/core-plugins-js">Services and Inteceptors in JavaScript</a></li>
<h3 id="rest-api" class="mt-2">Security Plugins</h2>
<li><a href="/docs/v7/security/overview">Overview</a></li>
<li><a href="/docs/v7/plugins/authentication-mechanisms">Authentication Mechanisms</a></li>
<li><a href="/docs/v7/plugins/authenticators">Authenticators</a></li>
<li><a href="/docs/v7/plugins/authorizers">Authorizers</a></li>
<li><a href="/docs/v7/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 Plugins</h2>
</a>
<ul id="security" class="collapse">
<li><a href="/docs/v7/security/tutorial">Auth^2 Tutorial</a></li>
<li><a href="/docs/v7/security/authentication">Authentication</a></li>
<li><a href="/docs/v7/security/authorization">Authorization</a></li>
<li><a href="/docs/v7/security/other-security-plugins">Other Security Plugins</a></li>
</ul>

<a data-toggle="collapse" href="#mongodb" role="button" aria-expanded="false" aria-controls="collapseExample">
<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/v7/mongodb-rest/tutorial">Tutorial</a></li>
<li><a href="/docs/v7/mongodb-rest/read-docs">Read Documents</a></li>
<li><a href="/docs/v7/mongodb-rest/write-docs">Write Documents</a></li>
<li><a href="/docs/v7/mongodb-rest/files">Binary Files with GridFS</a></li>
<li><a href="/docs/v7/mongodb-rest/aggregations">Aggregations</a></li>
<li><a href="/docs/v7/mongodb-rest/caching">Caching</a></li>
<li><a href="/docs/v7/mongodb-rest/dbs-collections">Manage Dbs and Collections</a></li>
<li><a href="/docs/v7/mongodb-rest/indexes">Indexes</a></li>
<li><a href="/docs/v7/mongodb-rest/relationships">Relationships</a></li>
<li><a href="/docs/v7/mongodb-rest/csv">Upload CSV files</a></li>
<li><a href="/docs/v7/mongodb-rest/json-schema-validation">JSON Schema Validation</a></li>
<li><a href="/docs/v7/mongodb-rest/transactions">Transactions</a></li>
<li><a href="/docs/v7/mongodb-rest/resource-uri">Resource URIs</a></li>
<li><a href="/docs/v7/mongodb-rest/representation-format">Representation Format</a></li>
<li><a href="/docs/v7/mongodb-rest/sample-data">Load Sample Data into MongoDB</a></li>
<li><a href="/docs/v7/mongodb-rest/etag">ETag</a></li>
<li><a href="/docs/v7/mongodb-rest/shard-keys">Shard Keys</a></li>
<li><a href="/docs/v7/mongodb-rest/monitoring">Monitoring</a></li>


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

<h3 id="rest-api" class="mt-2">Websocket API</h3>
<li><a href="/docs/v7/mongodb-websocket/">Overview</a></li>
<li><a href="/docs/v7/mongodb-websocket/change-streams">Streams definition</a></li>
<li><a href="/docs/v7/mongodb-websocket/variables">Variables</a></li>
<li><a href="/docs/v7/mongodb-websocket/examples">Examples</a></li>
</ul>

<style>
.collapsing {
-webkit-transition: none;
transition: none;
display: none;
}
</style>

<script type="text/javascript">
// on page load, show the menu element of the current pages
const menu = '{{ page.menu }}';
if (menu) {
$(`#${menu}`).collapse('show');
}
</script>
2 changes: 1 addition & 1 deletion _includes/head.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<meta property="og:title" content="{% if page.title %}RESTHeart - {{ page.title }}{% else %}{{ site.title }}{% endif %}">
<meta property="og:description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
<meta property="og:locale" content="en">
{% if page.docs_version != null and page.docs_version != 7 %}
{% if page.docs_version != null and page.docs_version != 8 %}
<!-- avoid search engine indexing of old documentation pages -->
<meta name="robots" content="noindex,nofollow">
{% endif %}
Expand Down
19 changes: 8 additions & 11 deletions _includes/header.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,14 @@ <h2 class="text-white"><strong>REST</strong>Heart</h2>
</div>
</header>
{% include run-restheart-seriously-banner.html %}
{% if page.docs_version != null and page.docs_version != 7 %}
<div class="alert alert-danger m-0 text-center" role="alert">
<strong>RESTHeart 7 is the current stable release. Switch documentation to <a href="{{ "/docs" | prepend: site.baseurl }}">v7</a></strong>
{% if page.docs_version != null and page.docs_version != 8 %}
<div class="alert alert-warning m-0 text-center" role="alert">
<strong>RESTHeart 8 is the current stable release. Switch documentation to <a href="{{ "/docs" | prepend: site.baseurl }}">v7</a></strong>
</div>
{% elsif page.docs_version != null %}
<div class="alert alert-success m-0 text-center" role="alert">
<strong>We are currently updating the documentation for v8. For a comprehensive list of changes, please see the <a href="{{ "/docs/upgrade-to-v8" | prepend: site.baseurl }}">Upgrade to v8</a></strong>
</div>
{% endif %}

<a target="_blank" class="gitter-open-chat-button fixed-bottom-right" href="https://join.slack.com/t/restheart/shared_invite/zt-1olrhtoq8-5DdYLBWYDonFGEALhmgSXQ"></a>

<!-- <script>
((window.gitter = {}).chat = {}).options = {
room: 'SoftInstigate/restheart'
};
</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script> -->
<a target="_blank" class="gitter-open-chat-button fixed-bottom-right" href="https://join.slack.com/t/restheart/shared_invite/zt-1olrhtoq8-5DdYLBWYDonFGEALhmgSXQ"></a>
11 changes: 10 additions & 1 deletion _layouts/docs-adoc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@
v{{ page.docs_version }}
</button>
<div class="dropdown-menu mt-2 mr-1 pb-2" aria-labelledby="dropdownMenuButton">
<a class="dropdown-item" href="{{ "/docs" | prepend: site.baseurl }}">
<a class="dropdown-item" href="{{ "/docs" | prepend: site.baseurl }}">
{% if page.docs_version == 8 %}
<strong>v8</strong>
{% else %}
v8
{% endif %}
</a>
<a class="dropdown-item" href="{{ "/docs/v7" | prepend: site.baseurl }}">
{% if page.docs_version == 7 %}
<strong>v7</strong>
{% else %}
Expand Down Expand Up @@ -83,6 +90,8 @@
{% include docs-v5-sidebar.html %}
{% elsif page.docs_version == 6 %}
{% include docs-v6-sidebar.html %}
{% elsif page.docs_version == 7 %}
{% include docs-v7-sidebar.html %}
{% else %}
{% include docs-sidebar.html %}
{% endif %}
Expand Down
9 changes: 8 additions & 1 deletion _layouts/docs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@
v{{ page.docs_version }}
</button>
<div class="dropdown-menu mt-2 mr-1 pb-2" aria-labelledby="dropdownMenuButton">
<a class="dropdown-item" href="{{ "/docs" | prepend: site.baseurl }}">
<a class="dropdown-item" href="{{ "/docs" | prepend: site.baseurl }}">
{% if page.docs_version == 8 %}
<strong>v8</strong>
{% else %}
v8
{% endif %}
</a>
<a class="dropdown-item" href="{{ "/docs/v7" | prepend: site.baseurl }}">
{% if page.docs_version == 7 %}
<strong>v7</strong>
{% else %}
Expand Down
4 changes: 2 additions & 2 deletions docs/index.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Get Started with RESTHeart v7
title: Get Started with RESTHeart v8
layout: docs-adoc
menu: overview
---

> *RESTHeart is a modern, JVM and GraalVM-based platform for building cloud-native HTTP microservices*
> *RESTHeart is a cutting-edge platform for building cloud-native HTTP microservices, leveraging Java Virtual Threads for enhanced performance and scalability. It is built for the JVM and GraalVM.*

NOTE: An _HTTP microservice_ is a server-side, lightweight component that exposes an HTTP API. Clients interact with it only through HTTP requests, usually - but not exclusively - using JSON payloads, decoupling the client from the underlying technology and completely separating the presentation from the business logic.

Expand Down
Loading

0 comments on commit b0d6c04

Please sign in to comment.