[HIGH] Update CI/CD for docs #82
Conversation
Update according to BIG-MAP/LabNotebookAppOntology.
|
@jesper-friis and @jsimonclark do you know what the error is here? (Failing action run) |
|
I think |
Is this something that either you @jesper-friis or @jsimonclark can fix directly in the branch for this PR? :) |
CasperWA
changed the title
Finalize build script. One can build the documentation simply by running python docs/scripts/build.py site It will then be built in the 'site' folder at the root of the repository. It utilizes the md_to_html.py script to generate HTML from all markdown files in the 'docs' folder and sub-folders (excluding any files found in 'assets', 'css', and 'scripts').
Update CI/CD workflows
Also ensure all requirements are installed for CI
CasperWA
changed the title
|
Updated this completely to comply with the excellent documentation updates implemented by @eibar-flores. Tests now succeed - the actual publishing workflow now needs to be fixed and remedied. |
CasperWA
requested review from
eibar-flores
and removed request for
jsimonclark
Update and add documentation for how to release a new BattINFO version as well as how to release the documentation.
|
|
||
| def rendering_workflow(): | ||
| # Get all Markdown files NOT in the assets, css, or scripts directories | ||
| md_files = [ |
There was a problem hiding this comment.
I dont fully follow the code from lines 63 to 85. I think you are scanning through md files not in the assets, css and scripts, but you have already moved them there. What is the purpose of this part of the code?
There was a problem hiding this comment.
63-65: Ensuring the output_path is a sub-folder of the repository folder, i.e., that it exists in the BattINFO folder. This is only checked if the output_path given is a relative path, i.e., something like docs/site or similar (so it shouldn't start with a slash).
((WILL UPDATE/EXPAND ON ANSWER for the other lines))
|
Could you elaborate on what are the consequences of having (or not) the ttl ending on the |
|
Greatly appreciated the two |
|
we've updated the documentation workflow according to recommendations from the EMMO working group. |
Update documentation CI/CD workflows similarly as to what is done in BIG-MAP/LabNotebookAppOntology.Closes #73
Updated/Reworked this PR:
IMPORTANT: A change in this PR adds
.ttlto the end of theowl:versionIRIvalue. If this is not intended, this should be reverted. One thing is that the IRI will currently not be resolvable due to thebattinfo.ttlfile being released under an extra sub-folder for v0.6.0. This can be changed manually, simultaneously with merging this PR, while a new version should proabably be released as well (v0.6.1?). How to proceed on this should be agreed upon before merging this PR and it should be well coordinated to ensure no real down time for users of BattINFO.Following @eibar-flores's excellent work with updating the documentation build workflow, this builds on that and ensures the ontology is also "published" as intended.
The CI/CD workflows have been updated and expanded in the following way:
gh-pagesbranch, updating it with the latest documentation and ontologies as well as preserving earlier versions of the ontologies.Furthermore, it's made callable by other workflows, useful for the "release" workflow (mentioned below).
owl:versionIRIandowl:versionInfovalues in the ontologies (now onlybattinfo.ttl) and also it's reference in thecatalog-v001.xmlfile. Then it will merge those changes back tomasterand run the Update GH-Pages workflow, effectively publishing the new ontology version.Finally, a bit of developer documentation has been added to explain the intended way of publishing the documentation as well as releasing a new BattINFO version.