Conversation
reluzita
left a comment
reluzita
left a comment
There was a problem hiding this comment.
From someone who has no context on this repo, it would be nice to have some more context on the beginning of both docs. I'm being picky here, but there are some inconsistencies in the punctuation throughout the docs. I would say that simply putting these through chatgpt or something to make it more consistent and have some more text explaining the context would be a simple way to make it more readable!
.github/ci_scripts_docs.md
Outdated
| The documentaion below showcases each CI scripts' functionality. | ||
|
|
||
| ## append_comment.sh | ||
| This script allows for the |
There was a problem hiding this comment.
This sentence is incomplete, maybe something got lost here?
.github/ci_workflows_docs.md
Outdated
| - task: cuda | ||
| - conda_env: test-env | ||
|
|
||
| The steps are presented below |
There was a problem hiding this comment.
| The steps are presented below | |
| The steps are presented below: |
.github/ci_workflows_docs.md
Outdated
| - conda_env: test-env | ||
|
|
||
| The steps are presented below | ||
| ### Setup or update software on host machine |
There was a problem hiding this comment.
| ### Setup or update software on host machine | |
| ### 1. Setup or update software on host machine |
.github/ci_workflows_docs.md
Outdated
| ### Setup or update software on host machine | ||
| This step aims to setup the host machine with the necessary images and packages (Ubuntu image, Nvidia docker engine resources and docker) | ||
|
|
||
| ### Setup and run tests |
There was a problem hiding this comment.
| ### Setup and run tests | |
| ### 2. Setup and run tests |
.github/ci_workflows_docs.md
Outdated
| - PYTHON_VERSION: 3.9 | ||
| - TASK: 'check-links' | ||
|
|
||
| The steps are disclosed below. |
There was a problem hiding this comment.
| The steps are disclosed below. | |
| The steps are disclosed below: |
.github/ci_workflows_docs.md
Outdated
|
|
||
| The steps are disclosed below. | ||
|
|
||
| ### Checkout repository |
There was a problem hiding this comment.
| ### Checkout repository | |
| ### 1. Checkout repository |
.github/ci_workflows_docs.md
Outdated
| ### Checkout repository | ||
| This step checks out the relevant repo's last 5 commits without any submodules | ||
|
|
||
| ### Setup and run tests |
There was a problem hiding this comment.
| ### Setup and run tests | |
| ### 2. Setup and run tests |
| - CONDA_ENV: test-env | ||
| - GITHUB_ACTIONS: 'true' | ||
|
|
||
| This workflow's steps are the following: |
There was a problem hiding this comment.
same as before, you get the idea 😅
ar-neto
force-pushed
the
docs/ci-documentation
branch
from
bd3ded9 to
18368c8
Compare
4 participants
The description of the CI scripts and workflows was documented via mermaid charts and markdown