Skip to content

Commit

Permalink
update workflow readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CallumWalley committed Sep 18, 2024
1 parent b96239b commit 1340341
Showing 1 changed file with 0 additions and 23 deletions.
23 changes: 0 additions & 23 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,6 @@

Description of current CI workflow.

## [fetch_includes.yml](fetch_includes.yml)

Retrieves dynamically generated content from external sources.

Currently retrieves:
- Software module list from [modules-list](https://github.com/nesi/modules-list).
- Glossary, spellcheck dictionary and snippets from [nesi-wordlist](https://github.com/nesi/nesi-wordlist)

It then runs [link_apps_pages.py](#link_apps_pagespy).

All modified files are added to a new branch called `new-assets` and merged into main.

In theory, all this could be done at deployment, but I wanted to make sure that changes to these remote files didn't break anything.

## [link_apps_pages.py](link_apps_pages.py)

A Python script used to add a link to the appropriate documentation to [modules-list.json](../../docs/assets/module-list.json).

The script checks all titles of input files, and sets the `support` key to be equal to the pages url.
It also adds whatever tags are on that page to the `domains` key.

_One day I would like to simplify this whole thing._

## [checks.yml](checks.yml)

A series of QA checks run on the documentation.
Expand Down

0 comments on commit 1340341

Please sign in to comment.