-
Notifications
You must be signed in to change notification settings - Fork 28
add script to auto-generate version-specific pages #86
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
90a0dd3
add script to auto-generate version-specific pages
boegel d305ec1
skip version-specific/* pages in MarkdownLint and codespell checks
boegel e18f8d0
Actions skip file specifications
branfosj e34ee17
escape /
branfosj 2ad47cd
more \
branfosj 0019fb7
just skip the supported software page for spelling
branfosj 6922283
newer markdownlint action version
branfosj 82cf976
fix version specifier
branfosj af7e191
Update markdown-linting.yml
branfosj 69acff5
better comment
branfosj 7ad451d
update auto-generated docs after fixing MarkDown formatting issues in…
boegel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,4 +12,5 @@ jobs: | |
| - name: MarkdownLint mdl Action | ||
| uses: actionshub/[email protected] | ||
| 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/.*" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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`` *)* |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.