diff --git a/README.md b/README.md index 05825be788b1d0e0d6436454e6aa0849d28d93c3..d3482f3ae680798e81cdd2ea7814eeadb4abe57d 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ within the CI/CD pipeline help to ensure a high quality documentation. ## Reporting Issues Issues concerning this documentation can reported via the GitLab -[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues). +[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues). Please check for any already existing issue before submitting your issue in order to avoid duplicate issues. diff --git a/doc.zih.tu-dresden.de/README.md b/doc.zih.tu-dresden.de/README.md index 4c0720a64973fa0ec97e3ffaf5eadcedc02013c2..1829a5bc54c26ce37f61f27410e45e8901488183 100644 --- a/doc.zih.tu-dresden.de/README.md +++ b/doc.zih.tu-dresden.de/README.md @@ -9,7 +9,7 @@ long describing complex steps, contributing is quite easy - trust us. ## Contribute via Issue Users can contribute to the documentation via the -[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues). +[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues). For that, open an issue to report typos and missing documentation or request for more precise wording etc. ZIH staff will get in touch with you to resolve the issue and improve the documentation. @@ -133,7 +133,7 @@ the documentation: wiki "mkdocs build --verbose && mkdocs serve -a 0.0.0.0:8000" ``` -You can view the documentation via [http://localhost:8000](http://localhost:8000) in your browser, now. +You can view the documentation via `http://localhost:8000` in your browser, now. If that does not work, check if you can get the URL for your browser's address bar from a different terminal window: @@ -200,7 +200,7 @@ locally on the documentation. At first, you should add a remote pointing to the documentation. ```Shell Session -~ git remote add upstream-zih git@gitlab.hrz.tu-chemnitz.de:zih/hpc-compendium/hpc-compendium.git +~ git remote add upstream-zih git@gitlab.hrz.tu-chemnitz.de:zih/hpcsupport/hpc-compendium.git ``` Now, you have two remotes, namely *origin* and *upstream-zih*. The remote *origin* points to your fork, @@ -210,8 +210,8 @@ whereas *upstream-zih* points to the original documentation repository at GitLab $ git remote -v origin git@gitlab.hrz.tu-chemnitz.de:LOGIN/hpc-compendium.git (fetch) origin git@gitlab.hrz.tu-chemnitz.de:LOGIN/hpc-compendium.git (push) -upstream-zih git@gitlab.hrz.tu-chemnitz.de:zih/hpc-compendium/hpc-compendium.git (fetch) -upstream-zih git@gitlab.hrz.tu-chemnitz.de:zih/hpc-compendium/hpc-compendium.git (push) +upstream-zih git@gitlab.hrz.tu-chemnitz.de:zih/hpcsupport/hpc-compendium.git (fetch) +upstream-zih git@gitlab.hrz.tu-chemnitz.de:zih/hpcsupport/hpc-compendium.git (push) ``` Next, you should synchronize your `main` branch with the upstream. @@ -243,7 +243,7 @@ new branch (a so-called feature branch) basing on the `main` branch and commit y The last command pushes the changes to your remote at branch `FEATUREBRANCH`. Now, it is time to incorporate the changes and improvements into the HPC Compendium. For this, create a -[merge request](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/merge_requests/new) +[merge request](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/merge_requests/new) to the `main` branch. ### Important Branches @@ -254,8 +254,8 @@ There are two important branches in this repository: - Branch containing recent changes which will be soon merged to main branch (protected branch) - Served at [todo url](todo url) from TUD VPN -- Main: Branch which is deployed at [doc.zih.tu-dresden.de](doc.zih.tu-dresden.de) holding the - current documentation (protected branch) +- Main: Branch which is deployed at [https://doc.zih.tu-dresden.de](https://doc.zih.tu-dresden.de) + holding the current documentation (protected branch) If you are totally sure about your commit (e.g., fix a typo), it is only the following steps: @@ -416,7 +416,7 @@ cp doc.zih.tu-dresden.de/util/pre-commit .git/hooks/ ### New Page and Pages Structure -The pages structure is defined in the configuration file [mkdocs.yaml](doc.zih.tu-dresden.de/mkdocs.yml). +The pages structure is defined in the configuration file [mkdocs.yaml](mkdocs.yml). ```Shell Session docs/ diff --git a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md index 6f16e925fe8008444a4e7046dd9737b839d266b4..9fbf5541a341d35918b33e8feda5026f66fc43ab 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md +++ b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md @@ -7,7 +7,7 @@ ## Contribute via Issue Users can contribute to the documentation via the -[GitLab issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues). +[GitLab issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues). For that, open an issue to report typos and missing documentation or request for more precise wording etc. ZIH staff will get in touch with you to resolve the issue and improve the documentation. diff --git a/doc.zih.tu-dresden.de/docs/index.md b/doc.zih.tu-dresden.de/docs/index.md index 62d54028a277290d8ca8d0576766910c9eeea4b3..24d3907def65508bc521a0fd3109b9792c76f19b 100644 --- a/doc.zih.tu-dresden.de/docs/index.md +++ b/doc.zih.tu-dresden.de/docs/index.md @@ -9,7 +9,7 @@ information. ## Contribution Issues concerning this documentation can reported via the GitLab -[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues). +[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues). Please check for any already existing issue before submitting your issue in order to avoid duplicate issues. diff --git a/doc.zih.tu-dresden.de/hackathon.md b/doc.zih.tu-dresden.de/hackathon.md index 4a49d2b68ede0134d9672d6b8513ceb8d0210060..d41781c45455139c62708c708cf42e05babc3b65 100644 --- a/doc.zih.tu-dresden.de/hackathon.md +++ b/doc.zih.tu-dresden.de/hackathon.md @@ -10,21 +10,21 @@ The goals for the hackathon are: ## twiki2md -The script `twiki2md` converts twiki source files into markdown source files using pandoc. It outputs the -markdown source files according to the old pages tree into subdirectories. The output and **starting -point for transferring** old content into the new system can be found at branch `preview` within -directory `twiki2md/root/`. +The script `twiki2md` converts twiki source files into markdown source files using pandoc. It +outputs the markdown source files according to the old pages tree into subdirectories. The +output and **starting point for transferring** old content into the new system can be found +at branch `preview` within directory `twiki2md/root/`. ## Steps ### Familiarize with New Wiki System -* Make sure your are member of the [repository](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium). +* Make sure your are member of the [repository](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium). If not, ask Danny Rotscher for adding you. * Clone repository and checkout branch `preview` ```Shell Session -~ git clone git@gitlab.hrz.tu-chemnitz.de:zih/hpc-compendium/hpc-compendium.git +~ git clone git@gitlab.hrz.tu-chemnitz.de:zih/hpcsupport/hpc-compendium.git ~ cd hpc-compendium ~ git checkout preview ``` @@ -38,23 +38,27 @@ directory `twiki2md/root/`. 1. Grab a markdown source file from `twiki2md/root/` directory (a topic you are comfortable with) 1. Find place in new structure according to [Typical Project Schedule](https://doc.zih.tu-dresden.de/hpc-wiki/bin/view/Compendium/TypicalProjectSchedule) - * Create new feature branch holding your work `~ git checkout -b <BRANCHNAME>`, whereas branch name can - be `<FILENAME>` for simplicity + + * Create new feature branch holding your work `~ git checkout -b <BRANCHNAME>`, whereas branch + name can be `<FILENAME>` for simplicity * Copy reviewed markdown source file to `docs/` directory via `~ git mv twiki2md/root/<FILENAME>.md doc.zih.tu-dresden.de/docs/<SUBDIR>/<FILENAME>.md` * Update navigation section in `mkdocs.yaml` + 1. Commit and push to feature branch via + ```Shell Session ~ git commit docs/<SUBDIR>/<FILENAME>.md mkdocs.yaml -m "MESSAGE" ~ git push origin <BRANCHNAME> ``` + 1. Run checks locally and fix the issues. Otherwise the pipeline will fail. * [Check links](README.md#check-links) (There might be broken links which can only be solved with ongoing transfer of content.) * [Check pages structure](README.md#check-pages-structure) * [Markdown Linter](README.md#markdown-linter) 1. Create - [merge request](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/merge_requests) + [merge request](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/merge_requests) against `preview` branch ### Review Content diff --git a/doc.zih.tu-dresden.de/mkdocs.yml b/doc.zih.tu-dresden.de/mkdocs.yml index 7af3fcc88da4cce6acddedfddf4b74efa2d7dbcb..ae931caec53b198e49a6a9837431bbc579c6288d 100644 --- a/doc.zih.tu-dresden.de/mkdocs.yml +++ b/doc.zih.tu-dresden.de/mkdocs.yml @@ -135,12 +135,12 @@ site_name: ZIH HPC Compendium site_description: ZIH HPC Compendium site_author: ZIH Team site_dir: public -site_url: https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium +site_url: https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium # uncomment next 3 lines if link to repo should not be displayed in the navbar repo_name: GitLab hpc-compendium -repo_url: https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium +repo_url: https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium edit_uri: blob/main/doc.zih.tu-dresden.de/docs/ # Configuration