RCIC website

This repo provides documentation created with Read The Docs.

Building HTML locally for testing

1. Install prerequisites

   pip3 install sphinx
   pip3 install sphinx_rtd_theme

2. Check out repo and build

   git clone [email protected]:RCIC-UCI-Public/website-rcic.git
   cd website-rcic
   make default
   make deploy

   See make help for more options

3. Point your local browser to build/html/index.html.

Editing

See notes.rst

Install on web server host

Current web server host is web3.oit.uci.edu (rcic.uci.edu is an alias )

1. Install prerequisites for system python

   pip3 install sphinx
   pip3 install sphinx_rtd_theme

   System default python 3.6 8 installs an older sphinx (latest available 5.3.0) which does not have a newer theme and results in a bit outdated look due to how it creates sections headings (section vs div).

2. Newer python3 can install newer sphinx with a better theme layout.

   Copy CentOS 7.9 RPMS from xcat and install as

   yum install rocks-devel-7.1-13.x86_64.rpm
   yum install rcic-module-support-1.2-1.x86_64.rpm
   yum install rcic-module-path-1.0-5.x86_64.rpm
   yum install python_3.8.0-module-3.8.0-5.x86_64.rpm
   yum install python_3.8.0-pip-20.0.2-4.x86_64.rpm
   yum install python_3.8.0-setuptools-46.0.0-4.x86_64.rpm
   yum install python_3.8.0-urllib3-1.25.8-4.x86_64.rpm
   
   bash
   module load python/3.8.0
   pip install sphinx==6.2.0
   pip install sphinx_rtd_theme

   This version results in correct themes.

   After the server update to OS 8 :

   Install corresponding RPMS for the updated OS.

   yum install rocks-devel
   yum install rcic-module-support
   yum install rcic-module-path
   yum install python_3.8.0-module
   yum install python_3.8.0-pip
   yum install python_3.8.0-setuptools
   yum install python_3.8.0-urllib3
   
   bash
   module load python/3.8.0
   pip install sphinx==6.2.0
   pip install sphinx_rtd_theme

3. Create a cron script ``cron-rtd-website `` and install as /etc/cron.hourly/rtd-website.

   The script:

   • checks out website repo (this repo)
   • verifies if there were any updates in the last hour,
   • in case there were updates it runs commands to create html files and installs resulting build/html/ as /var/www/html/rcic-website which is the website DocumentRoot, configured in /etc/httpd/conf.d/ssl.conf. A previous version is moved to /tmp.
   • a success/failure is recorded in /var/log/website-rtd.log

   See details in the cron script.

4. Periodically check broken links

   https://www.brokenlinkcheck.com/broken-links.php