Commit b743abf6 authored by Andrii Salnikov's avatar Andrii Salnikov

new structure of documentation tree

parent 9fab970e
Pipeline #4277 failed with stage
in 17 minutes and 30 seconds
build/
source/developers/configparser.rst
source/developers/lrms.rst
source/admins/reference.rst
......@@ -22,14 +22,14 @@ cd $DOCROOT
export PYTHONPATH="$CODE_DIR/src/utils/python"
# generate reference.rst
$CODE_DIR/src/utils/python/arcconfig-reference --convert-to-rst -r $CODE_DIR/src/doc/arc.conf.reference > "${DOCROOT}/source/user/reference.rst"
$CODE_DIR/src/utils/python/arcconfig-reference --convert-to-rst -r $CODE_DIR/src/doc/arc.conf.reference > "${DOCROOT}/source/admins/reference.rst"
# copy in-code developers documentation
cp $CODE_DIR/src/services/a-rex/lrms/README.lrms.rst ${DOCROOT}/source/developer/lrms.rst
cp $CODE_DIR/src/utils/python/README.configparser.rst ${DOCROOT}/source/developer/configparser.rst
cp $CODE_DIR/src/services/a-rex/lrms/README.lrms.rst ${DOCROOT}/source/developers/lrms.rst
cp $CODE_DIR/src/utils/python/README.configparser.rst ${DOCROOT}/source/developers/configparser.rst
# substitute code dir for commands
for cmdf in ${DOCROOT}/source/commands/*.rst; do
for cmdf in ${DOCROOT}/source/admins/commands/*.rst; do
sed "s#__CODE_DIR__#${CODE_DIR}#g" -i "$cmdf"
done
......@@ -50,5 +50,5 @@ rm -rf build/html/sdk
mv $CODE_DIR/src/doxygen/SDK/html build/html/sdk
# undo in-place changes of files
git checkout -- ${DOCROOT}/source/commands
git checkout -- ${DOCROOT}/source/admins/commands
build/
source/developer/configparser.rst
source/developer/lrms.rst
source/user/reference.rst
.. NorduGrid ARC documentation master file, created by
sphinx-quickstart on Fri Jul 20 15:14:52 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to NorduGrid ARC's documentation!
=========================================
.. toctree::
:maxdepth: 2
:caption: Contents:
user/index.rst
developer/index.rst
commands/index.rst
.. Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Documentation for ARC administrators
====================================
.. toctree::
:maxdepth: 4
try_arc6.rst
repository.rst
arc6_install_guide.rst
reference.rst
rtes.rst
scratch.rst
archery_vo.rst
.. # Dynamic content
# ./arcconfig-reference --convert-to-rst -r ../../doc/arc.conf.reference > reference.rst
......@@ -26,3 +26,4 @@ div.dnldpdf {
div.dnldpdf a {
color: #888;
}
......@@ -112,7 +112,7 @@ Each authgroup represents a set of users, whose identities are matched to config
Authorization as well as mapping are then configured based on authgroup membership.
Once defined, authgroups can be applied to filter access to the CE per interface (:ref:`[arex/ws/emies] <reference_arex_ws_emies>`, :ref:`[gridftpd/jobs] <reference_gridftpd_jobs>`) and per queue. The ``allowaccess`` option in the corresponding interface block defines the allowed authgroups.
Once defined, authgroups can be applied to filter access to the CE per interface (:ref:`[arex/ws/jobs] <reference_arex_ws_jobs>`, :ref:`[gridftpd/jobs] <reference_gridftpd_jobs>`) and per queue. The ``allowaccess`` option in the corresponding interface block defines the allowed authgroups.
In the shipped configuration the empty ``[authgroup: zero]`` is defined and applied to A-REX WS interface, the effect of which is to deny any access by default.
......@@ -340,7 +340,7 @@ For example, to enable the system-defined ``ENV/PROXY`` RTE, run:
[root ~]# arcctl rte enable ENV/PROXY
More details on operating RunTime Environments can be found in :doc:`rtes`.
More details on operating RunTime Environments can be found in :doc:`/admins/details/rtes`.
Information system
------------------
......
ARCHERY Documentation
=====================
.. toctree::
:maxdepth: 2
archery_vo.rst
In-deps ARC CE Configuration and Tuning Guides
==============================================
.. toctree::
:maxdepth: 2
rtes.rst
scratch.rst
......@@ -129,7 +129,7 @@ In ARC6 release operating RunTime Environments is changed significantly and rely
userrte [label="User-defined RTEs"];
userrte2 [label="User-defined RTEs",style="dashed",color="grey",fontcolor="grey"];
arcctl [label="arcctl", color="red", shape="oval", fontsize=16, fontcolor=red, href="../commands/arcctl.html" target="_blank"];
arcctl [label="arcctl", color="red", shape="oval", fontsize=16, fontcolor=red, href="../admins/commands/arcctl.html" target="_blank"];
systemrte -> arcctl;
userrte -> arcctl;
......@@ -138,9 +138,9 @@ In ARC6 release operating RunTime Environments is changed significantly and rely
subgraph clusterControlDir {
label="Control Directory"; fontsize=16;
node [shape=folder];
enabled [label="Enabled RTEs", href="../user/rtes.html#enabling-rtes", target="_top"];
default [label="Default RTEs", href="../user/rtes.html#default-rtes", target="_top"];
params [label="RTE parameters", href="../user/rtes.html#rte-parameters", target="_top", group=galign1];
enabled [label="Enabled RTEs", href="../admins/detals/rtes.html#enabling-rtes", target="_top"];
default [label="Default RTEs", href="../admins/details/rtes.html#default-rtes", target="_top"];
params [label="RTE parameters", href="../admins/details/rtes.html#rte-parameters", target="_top", group=galign1];
}
arcctl -> enabled;
......@@ -284,7 +284,7 @@ The first tag describe RTE origin (``system``, ``user`` or :ref:`dummy<dummy_rte
The special ``masked`` keyword indicates that RTE name used more that once and *by-name* operations will apply to other RTE script. In example ``ENV/PROXY`` will be enabled from user-defined location and system-defined will be masked. However it is possible to enable ``masked`` RTE :ref:`by path<rte_enable_by_path>`.
Listing the particular kind of RTEs (e.g. :ref:`enabled<enabling_rtes>`) is possible with appropriate argument (see :doc:`/commands/arcctl` for all available options):
Listing the particular kind of RTEs (e.g. :ref:`enabled<enabling_rtes>`) is possible with appropriate argument (see :doc:`/admins/commands/arcctl` for all available options):
.. code-block:: console
......
ARC Computing Element Deployment
********************************
.. toctree::
:maxdepth: 2
try_arc6.rst
arc6_install_guide.rst
reference.rst
details/index.rst
commands/index.rst
.. Dynamic content: arcconfig-reference --convert-to-rst -r ../../doc/arc.conf.reference > reference.rst
Deploying Other ARC Components
******************************
.. toctree::
:maxdepth: 2
archery/index.rst
......@@ -12,7 +12,7 @@ ARC6 comes with so-called *zero configuration* included and works out of the box
Step 1. Enable NorduGrid ARC6 repos
===================================
Latest alpha release of ARC6 is available from :doc:`NorduGrid Repositories <repository>`.
Latest alpha release of ARC6 is available from :doc:`NorduGrid Repositories </repos/repository>`.
.. note::
Aplha packages are in *testing* repository, so please make sure it is enabled, e.g. on RHEL-based systems you can use ``yum --enablerepo=nordugrid-testing`` to enable it for one transaction or ``yum-config-manager --enable nordugrid-testing`` to enable permanently.
......
......@@ -97,7 +97,9 @@ html_theme = 'alabaster'
# documentation.
#
html_theme_options = {
'logo': 'ARClogo.png'
'logo': 'ARClogo.png',
'sidebar_includehidden': False,
'sidebar_collapse': True
}
# Add any paths that contain custom static files (such as style sheets) here,
......@@ -120,6 +122,7 @@ html_sidebars = {
]
}
# Customizations
#def setup(app):
# app.add_stylesheet('css/svgwidth.css')
......
Documentation for developers
============================
Implemantation Details for Developers
=====================================
.. toctree::
:maxdepth: 4
:maxdepth: 2
nightlies-repo.rst
packages-services-naming.rst
configparser.rst
lrms.rst
../sdk/index.rst
Welcome to NorduGrid ARC's documentation!
=========================================
The *Advanced Resource Connector (ARC)* middleware, developed by the
`NorduGrid Collaboration <http://www.nordugrid.org>`_, is an open source software solution
enabling e-Science computing infrastructures with emphasis on processing of large data volumes.
ARC is being used to enable national and international e-infrastructures since its first release in 2002.
ARC is avaiable for variaty of GNU/Linux flavors via stable :doc:`Repositores <repos/repository>` or :doc:`Nigtly Builds <repos/nightlies-repo>` if you want to test the latest development release.
If you are new to ARC get started with the :doc:`Try ARC6 <admins/try_arc6>` quickstart guide to get an overview of main operations in the simple test case.
For production *Computing Element* deployment follow the :doc:`Installation and Configuration Guide <admins/arc6_install_guide>` that containst the structure and pointers to precise configuration of every ARC subsystem.
The ultimate description of each configuration option can be found in the :doc:`admins/reference`.
Documentation for Infrastructure Users
**************************************
This part of the documentation targeted to distributed computing infrastructure users that use either clients or SDK to run jobs and handle data transfers.
.. toctree::
:maxdepth: 2
users/index.rst
Documentation for Infrastructure Admins and Operators
*****************************************************
This section contains a documentation about all ARC middleware services deployment, configuration and operations.
If you are looking for ARC Computing Element setup instruction or performance tuning parameters you are in the right place.
.. toctree::
:maxdepth: 2
admins/index.rst
Technical Documents Describing ARC Components
*********************************************
Following documents gives a deep technical description of the various ARC components. If you are looking
for architecture internals (how parts of ARC was designed) you can follows this section.
.. toctree::
:maxdepth: 2
tech/index.rst
Documentation for Developers
============================
If you are looking for development internal details of ARC (like how some stuff was coded) this part of
documentation is for you. Mainly for those who want to contribute to the project development,
advanced troubleshooters or just interested.
.. toctree::
:maxdepth: 2
developers/index.rst
.. Not linked directly to the TOC but still built and available via linking or if you know what you are looking for
.. toctree::
:glob:
:hidden:
repos/*
wip/*
......@@ -123,7 +123,7 @@ Once the NorduGrid repositories are configured, install the packages with:
Or with ``dnf`` for Fedora.
Please refer to the :doc:`arc6_install_guide` for package selection.
Please refer to the :doc:`/admins/arc6_install_guide` for package selection.
Note that the NorduGrid repositories for RedHat Enterprise Linux/CentOS depends on the `EPEL <https://fedoraproject.org/wiki/EPEL>`_ repositories which must also be part of the YUM configuration.
......@@ -233,5 +233,5 @@ Install the packages with:
[root~]# apt-get install <list of package names>
Please refer to the :doc:`arc6_install_guide` for package selection.
Please refer to the :doc:`/admins/arc6_install_guide` for package selection.
Index of ARC Technical Documents
================================
.. |clearfloat| raw:: html
<div class="clearer"></div>
.. note::
Technical documents `exists <http://www.nordugrid.org/documents/>`_ for ARC5 only. Those that are verified to be relevant for ARC6 will be listed below
Hosting Environment of the Advanced Resource Connector middleware
*****************************************************************
.. image:: images/doc-manuals.png
:target: http://www.nordugrid.org/documents/ARCHED_article.pdf
:align: left
Document gives a deep technical description of the HED service container.
|clearfloat|
A Client Library for ARC
************************
.. image:: images/doc-manuals.png
:target: http://www.nordugrid.org/documents/client_technical.pdf
:align: left
Document describes from a technical viewpoint the plugin-based client library of ARC.
|clearfloat|
ARC Client Installation Instructions
====================================
.. note::
There are no client installation instructions available in the new documentation format yet. Please use the
`old installation instructions <http://www.nordugrid.org/documents/arc-client-install.html>`_ for main points
and hints.
CLI and SDK Documentation
=========================
.. toctree::
:maxdepth: 2
client_install.rst
../sdk/index.rst
============================
DTR (Data Transfer Reloaded)
============================
This page describes the data staging framework for ARC, code-named
DTR (Data Transfer Reloaded).
......
Work-in-progress Docs
=====================
Hidden area that holds unfinished documents to be build and available in the doc tree, but not yet linked to the right place.
.. toctree::
:maxdepth: 2
datastaging.rst
internal_submission_plugin.rst
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment