diff --git a/README.md b/README.md index de4c62e71112223b00ae12b9aedd157b0a6b3fc3..ebc192dc088ad147139c9bf7a48a1fe4a29c3ff5 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ https://compendium.hpc.tu-dresden.de/ by [TU Dresden/ZIH](https://tu-dresden.de/ We decided against a classical wiki software. Instead, we make use of the static site generator [mkdocs](https://www.mkdocs.org/). It creates static html files from markdown source files. All -(configuration, layout and content) files will be managed within this git repository. The +(configuration, layout and content) files will be managed within this Git repository. The documentation pages and configuration files are found in the folder `doc.zih.tu-dresden.de`. The generated static html files, i.e, the documentation, is deployed to a web server. Several checks within the CI/CD pipeline help to ensure a high quality documentation. diff --git a/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md b/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md index ab243e76cd0342444db9e23d49b356678a1638db..bb5e49d9d4854efe17c715ca505ebeed34234be8 100644 --- a/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md +++ b/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md @@ -28,7 +28,7 @@ project. Projects need to be registered beforehand (more info on the page This feature bases on [nbgitpuller](https://github.com/jupyterhub/nbgitpuller). Further information can be found in the [external documentation about nbgitpuller](https://jupyterhub.github.io/nbgitpuller/). -This extension for Jupyter notebooks can clone every public git repository into +This extension for Jupyter notebooks can clone every public Git repository into the users work directory. It's offering a quick way to distribute notebooks and other material to your students. @@ -61,7 +61,7 @@ The following parameters are available: | Parameter | Info | |---|---| -|`repo` | path to git repository| +|`repo` | path to Git repository| |`branch` | branch in the repository to pull from default: `master`| |`urlpath` | URL to redirect the user to a certain file, [more info about parameter urlpath](https://jupyterhub.github.io/nbgitpuller/topic/url-options.html#urlpath)| |`depth` | clone only a certain amount of latest commits not recommended| diff --git a/doc.zih.tu-dresden.de/docs/access/jupyterhub_teaching_example.md b/doc.zih.tu-dresden.de/docs/access/jupyterhub_teaching_example.md index da1a2e1506eeba1086784b749e2bdbd1f6138a02..15bc360fb7439470f9a542d8c4ee658552afeb36 100644 --- a/doc.zih.tu-dresden.de/docs/access/jupyterhub_teaching_example.md +++ b/doc.zih.tu-dresden.de/docs/access/jupyterhub_teaching_example.md @@ -20,7 +20,7 @@ or built in advance. We will focus on the custom environment approach here. ## Prerequisites -- A public git repository with the notebook files (`ipynb`) and all other starting files required +- A public Git repository with the notebook files (`ipynb`) and all other starting files required by participants. One option to host the repository is the [GitLab of TU Chemnitz](https://gitlab.hrz.tu-chemnitz.de/). - A [HPC project](../application/project_management.md) for teaching, with students as registered participants @@ -71,7 +71,7 @@ folder and add the file to the repository. ``` -Now, you can re-create the environment and the whole course from the git repository in the future. +Now, you can re-create the environment and the whole course from the Git repository in the future. To test the activation of the environment use: @@ -98,7 +98,7 @@ the ZIH JupyterLab. An `activate_workshop_env.sh` should have the following cont ``` !!! note - The file for installing the kernel should also be added to the git repository. + The file for installing the kernel should also be added to the Git repository. ### 4. Prepare the spawn link @@ -138,7 +138,7 @@ Lab. During testing, it may be necessary to reset the workspace to the initial state. There are two steps involved: -First, remove the cloned git repository in user home folder. +First, remove the cloned Git repository in user home folder. !!! warning Check carefully the syntax below, to avoid removing the wrong files. diff --git a/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md b/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md index 9cb7f3082b747c636617e2ce7ee9253f937ac35f..88a6999abf07312a0ed6969639084a1c5684a07b 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md +++ b/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md @@ -27,7 +27,7 @@ Once you are granted the developer role, choose "ZIH/hpcsupport/hpc-compendium" !!! hint "Git basics" - If you are not familiar with the basics of git-based document revision control yet, please have + If you are not familiar with the basics of Git-based document revision control yet, please have a look at [Gitlab tutorials](https://docs.gitlab.com/ee/tutorials/). ## Create a Branch diff --git a/doc.zih.tu-dresden.de/util/check-bash-syntax.sh b/doc.zih.tu-dresden.de/util/check-bash-syntax.sh index 98684ae258af4fcbd8637d40924b808b744d455b..1c5613b30ce35013debdaa5a717f9de8f5d3ef68 100755 --- a/doc.zih.tu-dresden.de/util/check-bash-syntax.sh +++ b/doc.zih.tu-dresden.de/util/check-bash-syntax.sh @@ -11,7 +11,7 @@ function usage () { echo "Search for bash files that have an invalid syntax." echo "" echo "Options:" - echo " -a Search in all bash files (default: git-changed files)" + echo " -a Search in all bash files (default: Git-changed files)" echo " -f=FILE Search in a specific bash file" echo " -s Silent mode" echo " -h Show help message" @@ -51,7 +51,7 @@ if [[ ${all_files} == true ]]; then elif [[ ! -z "${file}" ]]; then files=${file} else - echo "Search in git-changed files." + echo "Search in Git-changed files." files=`git diff --name-only --diff-filter=d "$(git merge-base HEAD "${branch}")" -- '*.sh' || true` fi diff --git a/doc.zih.tu-dresden.de/util/check-code-style.sh b/doc.zih.tu-dresden.de/util/check-code-style.sh index 95969a32b5cf7efea80fcaed7bab9b72dbc9189f..9438050371bb7d964868c1ab7a74c056e102b20a 100755 --- a/doc.zih.tu-dresden.de/util/check-code-style.sh +++ b/doc.zih.tu-dresden.de/util/check-code-style.sh @@ -10,7 +10,7 @@ # endings # > -h|--help|-help|help : Print help message # > file : Checks coding style of provided file -# > If no arguments are provided, only the new/git-changed files will be +# > If no arguments are provided, only the new/Git-changed files will be # checked #------------------------------------------------------------------------------- # TODO: Indent check for bash @@ -102,7 +102,7 @@ if [[ $# -eq 1 ]]; then ;; esac elif [[ $# -eq 0 ]]; then - echo "Search in git-changed files." + echo "Search in Git-changed files." files=$(git diff --name-only --diff-filter=d "$(git merge-base HEAD "${branch}")" -- '*.md' '*.sh' || true) else usage diff --git a/doc.zih.tu-dresden.de/util/check-filesize.sh b/doc.zih.tu-dresden.de/util/check-filesize.sh index d1b9d4e643de0ce215e491747dd7abe7a174c373..4463b297fda160bed1c1090cd20604e295b49b87 100755 --- a/doc.zih.tu-dresden.de/util/check-filesize.sh +++ b/doc.zih.tu-dresden.de/util/check-filesize.sh @@ -36,10 +36,10 @@ branch="origin/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-preview}" source_hash=`git merge-base HEAD "${branch}"` for f in $(git diff --name-only --diff-filter=d ${source_hash}); do - # Do not check size of git lfs files. + # Do not check the size of Git LFS files. filter_attribute=$(git check-attr filter -- "${f}") if [[ "${filter_attribute#*: filter: }" = "lfs" ]]; then - echo "Skip file ${f} because it is a git lfs file." + echo "Skip file ${f} because it is a Git LFS file." continue fi fs=$(wc -c ${f} | awk '{print $1}') diff --git a/doc.zih.tu-dresden.de/util/check-links.sh b/doc.zih.tu-dresden.de/util/check-links.sh index 89f7abed24baccc14dadd8b057f97668d5ab8244..6944be051f8dab63dcfee7f8f82a61e9b9739b50 100755 --- a/doc.zih.tu-dresden.de/util/check-links.sh +++ b/doc.zih.tu-dresden.de/util/check-links.sh @@ -4,7 +4,7 @@ # Checks internal and external links for markdown files (.md) of the repository # (i.e. HPC compendium). This script can check the URLs # 1. in all markdown files -# 2. git-changed markdown files +# 2. Git-changed markdown files # 3. single markdown file # # For option 1, we make use of the html-proofer-plugin, which is configured in mkdocs.yml. @@ -35,7 +35,7 @@ Options: <file> Check links in the provided markdown file -a; --all Check links in all markdown files -i; --internal Check links in all markdown files (internal links only) - -c; --changed Check links in all git-changed files + -c; --changed Check links in all Git-changed files EOF } @@ -125,7 +125,7 @@ if [[ $# -ge 1 ]]; then check_all_files_hpp ;; -c | --changed) - echo "Info: Checking links in modified files." + echo "Info: Checking links in Git-changed files." check_changed_files ;; *) diff --git a/doc.zih.tu-dresden.de/util/check-templated-code-snippets.sh b/doc.zih.tu-dresden.de/util/check-templated-code-snippets.sh index 7710659b9feb87ef468fb17958e532325a6b0473..c273f12476ce4d1098893063f441054357449c4f 100755 --- a/doc.zih.tu-dresden.de/util/check-templated-code-snippets.sh +++ b/doc.zih.tu-dresden.de/util/check-templated-code-snippets.sh @@ -35,7 +35,7 @@ if [[ $# -eq 1 ]]; then ;; esac elif [[ $# -eq 0 ]]; then - echo "Search in git-changed files." + echo "Search in Git-changed files." files=`git diff --name-only --diff-filter=d "$(git merge-base HEAD "${branch}")" -- '*.md' || true` else usage diff --git a/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh b/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh index 9f2cadd3a304a0af167cd66234d5097d039a196a..ca15012f984be2a74900dd3fda535525209f6233 100755 --- a/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh +++ b/doc.zih.tu-dresden.de/util/grep-forbidden-patterns.sh @@ -129,7 +129,7 @@ $0 [options] Search forbidden patterns in markdown files. Options: - -a Search in all markdown files (default: git-changed files) + -a Search in all markdown files (default: Git-changed files) -f Search in a specific markdown file -s Silent mode -h Show help message @@ -182,7 +182,7 @@ if [[ ${all_files} == true ]]; then elif [[ ! -z "${file}" ]]; then files=${file} else - echo "Search in git-changed files." + echo "Search in Git-changed files." files=`git diff --name-only --diff-filter=d "$(git merge-base HEAD "${branch}")" -- '*.md'` fi