Skip to content

Commit

Permalink
added feature image to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mfenner committed Jun 10, 2024
1 parent f3c8dcf commit b6b73e1
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 3 deletions.
Binary file added _site/assets/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions _site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,7 @@


<h1 id="welcome-to-inveniordm-starter">Welcome to InvenioRDM Starter</h1>
<p><img alt="Screenshot" src="assets/screenshot.png" /></p>
<h2 id="introduction">Introduction</h2>
<p>InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing</p>
<ul>
Expand All @@ -378,10 +379,10 @@ <h2 id="technology-choices">Technology Choices</h2>
<ul>
<li><code>invenio-cli</code> is not used.</li>
<li>The <code>invenio-app-rdm</code> Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally.</li>
<li><code>Python:3.12</code> based on Debian Bookworm is used as the Docker base image, instead of <code>Almalinux</code>.</li>
<li><a href="https://www.debian.org/releases/bookworm/">Debian Bookworm</a> is used as the Docker base image, instead of <code>Almalinux</code>.</li>
<li>The Docker image uses <code>Python 3.12</code> and <code>Node 20</code>.</li>
<li>The Docker image uses <code>gunicorn</code> as the WSGI server instead of <code>uwsgi</code>.</li>
<li>Docker Compose uses <code>Caddy</code> as the reverse proxy server instead of <code>Nginx</code>. InvenioRDM Starter run at <code>https://localhost</code>, and uses a self-signed certificate issued by <code>Caddy</code>.</li>
<li>Docker Compose uses <code>Caddy</code> as the reverse proxy server instead of <code>Nginx</code>. InvenioRDM Starter will run locally at <code>https://localhost</code>, and uses a self-signed certificate issued by <code>Caddy</code>.</li>
<li>Docker Compose uses <code>Redis</code> as the message broker instead of <code>RabbitMQ</code></li>
</ul>

Expand Down
2 changes: 1 addition & 1 deletion _site/search/search_index.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to InvenioRDM Starter Introduction InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults. Requirements Docker Desktop ( Windows , macOS , Linux ) or Docker Engine ( Linux ) A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required. Quickstart Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost . Technology Choices InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Python:3.12 based on Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . InvenioRDM Starter run at https://localhost , and uses a self-signed certificate issued by Caddy . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Welcome to InvenioRDM Starter"},{"location":"#welcome-to-inveniordm-starter","text":"","title":"Welcome to InvenioRDM Starter"},{"location":"#introduction","text":"InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults.","title":"Introduction"},{"location":"#requirements","text":"Docker Desktop ( Windows , macOS , Linux ) or Docker Engine ( Linux ) A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required.","title":"Requirements"},{"location":"#quickstart","text":"Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost .","title":"Quickstart"},{"location":"#technology-choices","text":"InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Python:3.12 based on Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . InvenioRDM Starter run at https://localhost , and uses a self-signed certificate issued by Caddy . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Technology Choices"}]}
{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to InvenioRDM Starter Introduction InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults. Requirements Docker Desktop ( Windows , macOS , Linux ) or Docker Engine ( Linux ) A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required. Quickstart Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost . Technology Choices InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . InvenioRDM Starter will run locally at https://localhost , and uses a self-signed certificate issued by Caddy . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Welcome to InvenioRDM Starter"},{"location":"#welcome-to-inveniordm-starter","text":"","title":"Welcome to InvenioRDM Starter"},{"location":"#introduction","text":"InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing a prebuilt Invenio-App-RDM Docker image. a Docker Compose configuration file with sensible defaults.","title":"Introduction"},{"location":"#requirements","text":"Docker Desktop ( Windows , macOS , Linux ) or Docker Engine ( Linux ) A local installation of Python or Invenio-CLI is not required. A git client is recommended but not required.","title":"Requirements"},{"location":"#quickstart","text":"Download the docker-compose.yml file from the InvenioRDM Starter git repository . Alternatively, clone the repository. Run docker-compose up in the same directory as the docker-compose.yml file. Open a web browser and navigate to https://localhost .","title":"Quickstart"},{"location":"#technology-choices","text":"InvenioRDM Starter differs from the Dockerfile and docker-compose.yml generated by the invenio-cli command-line tool in the following ways: invenio-cli is not used. The invenio-app-rdm Docker prebuilt image provided by InvenioRDM Starter is used instead of building the image locally. Debian Bookworm is used as the Docker base image, instead of Almalinux . The Docker image uses Python 3.12 and Node 20 . The Docker image uses gunicorn as the WSGI server instead of uwsgi . Docker Compose uses Caddy as the reverse proxy server instead of Nginx . InvenioRDM Starter will run locally at https://localhost , and uses a self-signed certificate issued by Caddy . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Technology Choices"}]}
Binary file modified _site/sitemap.xml.gz
Binary file not shown.
Binary file added docs/assets/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Welcome to InvenioRDM Starter

![Screenshot](assets/screenshot.png)

## Introduction

InvenioRDM Starter is an implementation of the InvenioRDM Turn-key research data management repository focusing on easy deployment and configuration. This is achieved by providing
Expand Down

0 comments on commit b6b73e1

Please sign in to comment.