updated documentation

front-matter · Jun 10, 2024 · b43e4df · b43e4df
1 parent 2c01da4
commit b43e4df
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 11 deletions.
diff --git a/_site/index.html b/_site/index.html
@@ -245,8 +245,29 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#installation-for-development-and-testing" class="md-nav__link">
-    Installation for Development and Testing
+  <a href="#introduction" class="md-nav__link">
+    Introduction
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#requirements" class="md-nav__link">
+    Requirements
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#quickstart" class="md-nav__link">
+    Quickstart
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#technology-choices" class="md-nav__link">
+    Technology Choices
   </a>
 
 </li>
@@ -286,8 +307,29 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#installation-for-development-and-testing" class="md-nav__link">
-    Installation for Development and Testing
+  <a href="#introduction" class="md-nav__link">
+    Introduction
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#requirements" class="md-nav__link">
+    Requirements
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#quickstart" class="md-nav__link">
+    Quickstart
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#technology-choices" class="md-nav__link">
+    Technology Choices
   </a>
 
 </li>
@@ -313,9 +355,36 @@
 
 
 <h1 id="welcome-to-inveniordm-starter">Welcome to InvenioRDM Starter</h1>
-<h2 id="installation-for-development-and-testing">Installation for Development and Testing</h2>
-<p>To install InvenioRDM on your local machine for Testing, use the Docker Compose
-configuration provided by InvenioRDM Starter.</p>
+<h2 id="introduction">Introduction</h2>
+<p>InvenioRDM Starter is an implementation of the InvenioRDM repository management
+platform focused on easy deployment and configuration. This is achieved by providing</p>
+<ul>
+<li>a prebuilt Invenio-App-RDM Docker image.</li>
+<li>a Docker Compose configuration file with sensible defaults.</li>
+</ul>
+<h2 id="requirements">Requirements</h2>
+<ul>
+<li>Docker Desktop (Windows, macOS) or Docker Engine (Linux)</li>
+</ul>
+<p>A local installation of Python or Invenio-CLI is not required.</p>
+<h2 id="quickstart">Quickstart</h2>
+<ul>
+<li>Download the <code>docker-compose.yml</code> file from the <a href="https://github.com/front-matter/invenio-rdm-starter">InvenioRDM Starter git repository</a>. Alternatively, clone the repository.</li>
+<li>Run <code>docker-compose up</code> in the same directory as the <code>docker-compose.yml</code> file.</li>
+<li>Open a web browser and navigate to <code>https://localhost</code>.</li>
+</ul>
+<h2 id="technology-choices">Technology Choices</h2>
+<p>InvenioRDM Starter differs from the <code>Dockerfile</code> and <code>docker-compose.yml</code> generated by
+the <code>invenio-cli</code> command-line tool in the following ways:</p>
+<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>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>.</li>
+<li>Docker Compose uses <code>Redis</code> as the message broker instead of <code>RabbitMQ</code></li>
+</ul>
 
 
 

diff --git a/_site/search/search_index.json b/_site/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to InvenioRDM Starter Installation for Development and Testing To install InvenioRDM on your local machine for Testing, use the Docker Compose configuration provided by InvenioRDM Starter.","title":"Welcome to InvenioRDM Starter"},{"location":"#welcome-to-inveniordm-starter","text":"","title":"Welcome to InvenioRDM Starter"},{"location":"#installation-for-development-and-testing","text":"To install InvenioRDM on your local machine for Testing, use the Docker Compose configuration provided by InvenioRDM Starter.","title":"Installation for Development and Testing"}]}
+{"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 repository management platform focused 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) or Docker Engine (Linux) A local installation of Python or Invenio-CLI is 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 . 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 repository management platform focused 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) or Docker Engine (Linux) A local installation of Python or Invenio-CLI is 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 . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Technology Choices"}]}
diff --git a/_site/sitemap.xml.gz b/_site/sitemap.xml.gz
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,34 @@
 # Welcome to InvenioRDM Starter
 
-## Installation for Development and Testing
+## Introduction
 
-To install InvenioRDM on your local machine for Testing, use the Docker Compose
-configuration provided by InvenioRDM Starter.
+InvenioRDM Starter is an implementation of the InvenioRDM repository management
+platform focused 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) or Docker Engine (Linux)
+
+A local installation of Python or Invenio-CLI is not required.
+
+## Quickstart
+
+* Download the `docker-compose.yml` file from the [InvenioRDM Starter git repository](https://github.com/front-matter/invenio-rdm-starter). 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`.
+* Docker Compose uses `Redis` as the message broker instead of `RabbitMQ`
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 Installation for Development and Testing To install InvenioRDM on your local machine for Testing, use the Docker Compose configuration provided by InvenioRDM Starter.","title":"Welcome to InvenioRDM Starter"},{"location":"#welcome-to-inveniordm-starter","text":"","title":"Welcome to InvenioRDM Starter"},{"location":"#installation-for-development-and-testing","text":"To install InvenioRDM on your local machine for Testing, use the Docker Compose configuration provided by InvenioRDM Starter.","title":"Installation for Development and Testing"}]}
		{"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 repository management platform focused 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) or Docker Engine (Linux) A local installation of Python or Invenio-CLI is 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 . 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 repository management platform focused 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) or Docker Engine (Linux) A local installation of Python or Invenio-CLI is 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 . Docker Compose uses Redis as the message broker instead of RabbitMQ","title":"Technology Choices"}]}