We have GitHub badges that show current status. Using the :target: setting for these images, you can link to a specific GitHub page.


Most of our documentation about patron management is in ReQUIAM_csv and ReQUIAM. An overview of how these repositories work should be provided here.


Adding .idea to .gitignore so that git ignores PyCharm settings to the repository

Include on the main page each GitHub repository and their functions. Should include:

• Repository link
• Version information (use GitHub badge)
• CHANGELOG if available
• RTDs page or README.txt
• PyPI status

Summary

Update dependencies

Objectives

Update dependencies in requirements.txt to the latest stable versions.

Proposal

• update requirements.txt, which includes:

• sphinx: latest stable version: 7.20

• sphix-rtd-theme: latest stable version: 1.3.0

• sphinx-autodoc-typehints: latest stable version: 1.24.0

• read and update RTD documentation

Testing notes

• Testing RTD compile errors
• Testing RTD websites on ReDATA documentation

Additional notes

This is related to redata-commons Issue 40

Implemented in: TBD

LD-Cool-P and ldcoolp-figshare document how our data curation workflow works; however, a more general documentation of the data curation is needed.


When UAL-RE/ReQUIAM#157 is closed, we can update the table to point to the new CHANGELOG.md.

This can be combined with #13 in a single PR since both are small fixes.

The RTDs page is now live at https://requiam.readthedocs.io.

A simple update to source/repos.rst is needed.


This project mangaement web page https://redata.readthedocs.io/en/latest/project-management.html missed an important workflow and screenshot examples for updating related codes in ReData software.

Solution: updating source/project-management.rst file, and then double-check re-complied HTML web pages at https://redata.readthedocs.io/en/stable/project-management.html

For example, In LD-Cool-P. when something (e.g. a new version tag, an issue) is resolved, all related files should be updated. see UAL-RE/LD-Cool-P@d667e1a as an example. The following files. shall be updated:
Update init.py
Update setup.py
Update README.md
Update changelog.md

For badges that lists the status of repositories issues (open/close) via Shields.io badges, the query will need: is:issue. Otherwise this will include open/merged PRs.

Ultimately our general public documentation for ReDATA software will be published in redata.readthedocs.io. Let's save this as a placeholder and revisit later with additional action items and issues for content.

Action item:

• Include a source folder containing documentation. Since no code is provided here, there's no need for a docs folder. The entire repo is documentation
• Add sphinx-build GitHub actions
• Publish it as redata.readthedocs.org

On the first action item, what I did was change the Admin settings to specify where requirements.txt and conf.py are.

Another section describing:

• Our best practices
• Statuses of repositories
• General DevOps workflow