Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add script to auto-generate version-specific pages #86

Merged
merged 11 commits into from
Jan 4, 2023
5 changes: 3 additions & 2 deletions .github/workflows/markdown-linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ jobs:
uses: actions/checkout@v3

- name: MarkdownLint mdl Action
uses: actionshub/markdownlint@2.0.2
uses: actionshub/markdownlint@v2.1.2
with:
filesToIgnoreRegex: "docs/demos/.*"
# filter out version-specific/* for now, until we fix all issues that mdl trips over
filesToIgnoreRegex: "(docs\\/demos\\/.*|docs\\/version-specific\\/.*)"
5 changes: 4 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ jobs:
with:
check_filenames: true
ignore_words_list: atleast,ninjs,simpy,proovread,namd,precice
exclude_file: docs/js/asciinema-player-2.6.1.js
# filter out
# docs/js/asciinema-player-2.6.1.js as it is not markdown
# version-specific/supported-software.md as the software descriptions have spelling errors
skip: './docs/js/asciinema-player-2.6.1.js,./docs/version-specific/supported-software.md'

- name: check internal links
run: |
Expand Down
18 changes: 8 additions & 10 deletions docs/version-specific/config-file-constants.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# Constants available (only) in configuration files {: #avail_cfgfile_constants }

!!! warning
This page will soon replace <https://docs.easybuild.io/en/latest/version-specific/config_file_constants.html>.
### Only in 'DEFAULT' section:

**
It still needs to be ported from *reStructuredText* (.rst) to *MarkDown* (.md),
and you can help with that!
**
Constant name |Constant help |Constant value
--------------------------|---------------------------------------------------|-------------------------------------------------------------------
``DEFAULT_REPOSITORYPATH``|Default easyconfigs repository path |``/home/example/.local/easybuild/ebfiles_repo``
``DEFAULT_ROBOT_PATHS`` |List of default robot paths (':'-separated) |``/home/example/work/easybuild-easyconfigs/easybuild/easyconfigs``
``HOME`` |Current user's home directory, expanded '~' |``/home/example``
``USER`` |Current username, translated uid from password file|``example``

- source: [`docs/version-specific/config_file_constants.rst` in `easybuilders/easybuild` repo](https://raw.githubusercontent.com/easybuilders/easybuild/develop/docs/version-specific/config_file_constants.rst)
- target: [`docs/version-specific/config-file-constants.md` in `easybuilders/easybuild-docs` repo](https://github.com/easybuilders/easybuild-docs/tree/main/docs/version-specific/config-file-constants.md)

See <https://github.com/easybuilders/easybuild-docs> for more information.
*(see also* ``eb --avail-cfgfile-constants`` *)*
Loading