Added Sphinx documentation
Details: - Added index and intro pages - Added sphinx-maven plugin in pom.xml
This commit is contained in:
parent
f2b5b9e857
commit
b0fbd4c385
|
|
@ -0,0 +1,20 @@
|
|||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'StorageHub'
|
||||
copyright = '2024, Lucio Lelii, Biagio Peccerillo'
|
||||
author = 'Lucio Lelii, Biagio Peccerillo'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '2.0.1'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
}
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = []
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
Welcome to StorageHub's documentation!
|
||||
======================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
intro.rst
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
Introduction
|
||||
============
|
||||
|
||||
StorageHub is a versatile service designed to provide seamless access
|
||||
to various storage resources, ensuring data persistence and management. It acts
|
||||
as an intermediary layer that can interface with any underlying storage
|
||||
solution, such as Amazon S3 or MongoDB, offering a unified and flexible approach
|
||||
to storage management.
|
||||
|
||||
Base URL
|
||||
--------
|
||||
|
||||
In the production environment, its current value is https://api.d4science.org/
|
||||
|
||||
Key Features
|
||||
------------
|
||||
|
||||
Flexibility and Integration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
StorageHub is designed to be highly flexible, allowing it to serve as an
|
||||
intermediate layer for diverse storage solutions. This flexibility ensures that
|
||||
it can adapt to different storage backends without requiring significant changes
|
||||
to the applications that rely on it.
|
||||
|
||||
RESTful Interface
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
StorageHub exposes a RESTful API, which allows any application capable of making
|
||||
HTTP requests to access it. This REST interface provides a standardized way to
|
||||
interact with the storage resources, enabling easy integration with various
|
||||
applications and services. See the available REST-API on `StorageHub API docs
|
||||
<../api-docs/index.html>`_.
|
||||
|
||||
Metadata Management
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
StorageHub leverages a JackRabbit-based object store to manage all metadata
|
||||
associated with the stored data. This ensures that metadata is efficiently
|
||||
organized and easily retrievable, enhancing the overall data management
|
||||
capabilities of the service.
|
||||
|
||||
Direct Payload Storage
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
While metadata is handled by JackRabbit, the actual data payloads are stored
|
||||
directly on the underlying storage solutions. This approach optimizes storage
|
||||
efficiency and performance, ensuring that large data payloads are managed
|
||||
effectively.
|
||||
|
||||
Primary Use Cases
|
||||
-----------------
|
||||
|
||||
Workspace
|
||||
~~~~~~~~~
|
||||
|
||||
The main application that interacts with StorageHub is the Workspace portlet,
|
||||
which is easily accessible from the Virtual Research Environments (VREs). The
|
||||
Workspace provides a "standard" HTML interface where users can perform all the
|
||||
common operations available in a file system, such as creating, reading,
|
||||
updating, and deleting files and directories.
|
||||
|
||||
In addition to these standard file system operations, the Workspace offers
|
||||
features that are specific to VREs. These include publishing on the Catalogue,
|
||||
sharing resources with other users, and managing versions of files. These
|
||||
capabilities make the Workspace a versatile tool for managing data within the
|
||||
VREs, leveraging the services provided by StorageHub.
|
||||
|
||||
Java Client
|
||||
~~~~~~~~~~~
|
||||
|
||||
The methods of the Web Service can be called by writing your own REST client
|
||||
application or by using already existing REST client plugins.
|
||||
|
||||
In case of a Java client, we provide the StorageHub Client Library, which is a
|
||||
Java library designed to facilitate seamless interaction with StorageHub. It
|
||||
abstracts the complexities of the REST API, providing a more intuitive and
|
||||
convenient interface for Java developers.
|
||||
|
||||
The StorageHub Client Library allows developers to easily integrate StorageHub's
|
||||
capabilities into their applications without dealing with the intricacies of
|
||||
HTTP requests and responses. The library handles all the necessary communication
|
||||
with StorageHub, allowing developers to focus on their application's core
|
||||
functionality.
|
||||
|
||||
.. tip:: If you're coding in Java, it is recommended that you include the
|
||||
StorageHub Client Library into your project.
|
||||
|
||||
Authorization
|
||||
-------------
|
||||
|
||||
D4Science adopts state-of-the-art industry standards for authentication and
|
||||
authorization. Specifically, the implementation fully adopts `OIDC (OpenID
|
||||
Connect) <https://openid.net/connect>`_ for authentication and UMA 2 (User
|
||||
Managed Authorization) for authorization flows. `JSON Web Token (JWT) Access
|
||||
token <https://jwt.io/>`_ are used for both authentication and authorization.
|
||||
|
||||
Obtain your Bearer token here: https://dev.d4science.org/how-to-access-resources
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.https://www.sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
23
pom.xml
23
pom.xml
|
|
@ -490,6 +490,27 @@
|
|||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<!-- SPHINX PLUGIN triggered at 'compile' -->
|
||||
<plugin>
|
||||
<groupId>kr.motd.maven</groupId>
|
||||
<artifactId>sphinx-maven-plugin</artifactId>
|
||||
<version>2.10.0</version>
|
||||
<configuration>
|
||||
<outputDirectory>
|
||||
${project.build.directory}/${project.artifactId}/docs</outputDirectory>
|
||||
<builder>html</builder>
|
||||
<configDirectory>${basedir}/docs</configDirectory>
|
||||
<sourceDirectory>${basedir}/docs</sourceDirectory>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>process-resources</phase>
|
||||
<goals>
|
||||
<goal>generate</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
|
|
@ -523,4 +544,4 @@
|
|||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
</project>
|
||||
Loading…
Reference in New Issue