From 544d928fafdf5816290140bafac6d4039219fd1d Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Wed, 5 Jul 2023 09:53:34 +0200 Subject: [PATCH 1/8] document contribution policy for adding software to EESSI --- docs/software_layer/adding_software.md | 4 ++ docs/software_layer/contribution_policy.md | 80 ++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 85 insertions(+) create mode 100644 docs/software_layer/contribution_policy.md diff --git a/docs/software_layer/adding_software.md b/docs/software_layer/adding_software.md index ba300c392..e08d67097 100644 --- a/docs/software_layer/adding_software.md +++ b/docs/software_layer/adding_software.md @@ -9,6 +9,10 @@ To add software to EESSI, you should go through the semi-automatic software inst * 3) Instructing the [bot :robot:](../bot.md) to deploy the built software for ingestion into the EESSI repository; * 4) Merging the pull request once CI indicates that the software has been ingested. :white_check_mark: +!!! warning + + Make sure you are also aware of our [contribution policy](contribution_policy.md) when adding software to EESSI. + ### Preparation Before you can make a pull request to the [software-layer](https://github.com/EESSI/software-layer), diff --git a/docs/software_layer/contribution_policy.md b/docs/software_layer/contribution_policy.md new file mode 100644 index 000000000..d90bee229 --- /dev/null +++ b/docs/software_layer/contribution_policy.md @@ -0,0 +1,80 @@ +# Contribution policy + +When [openining a pull request to add software to EESSI](adding_software.md), the following requirements must +be taken into account. + +!!! note + + These requirements are subject to change, please check back regularly. + +## Open source software + +Only **open source software** can be added to the EESSI repository. + +Make sure that you are aware of software license, and that redistribution is allowed. + +For more information about a specific license, see the [SPDX license list](https://spdx.org/licenses/). + +!!! note + + We intend to automatically verify that this requirement is met, + by requiring that the [SPDX license identifier](https://spdx.dev/ids/) is provided for all software. + +## Built by the bot + +All software included in the EESSI repository *must* be built autonomously by [our bot :robot:](../bot.md), +see also the [semi-automatic software installation procedure](adding_software.md). + +## Supported by EasyBuild + +Currently, we require that all software being added to EESSI is supported by the *EasyBuild release* being used +to perform the installation. + +That is, the easyconfig files used for the installation *must be included in the EasyBuild release*. + +We do allow the use of [`--from-pr`](https://docs.easybuild.io/integration-with-github/#github_from_pr) and +[`--include-easyblocks-from-pr`](https://docs.easybuild.io/integration-with-github/#github_include_easyblocks_from_pr) +to pull in changes required to make the installation work correctly in the EESSI build environment, +but only if that is strictly required. + +!!! note + + This restriction may be relaxed later to also allow adding software that is not supported yet in the latest + EasyBuild release, or to allow for installing software with other tools. + +## Supported compiler toolchains + +A [compiler toolchain](https://docs.easybuild.io/terminology/#toolchains) that is still supported by the latest +EasyBuild must be used for building the software. + +More information on deprecated toolchains in EasyBuild is available +[here](https://docs.easybuild.io/deprecated-easyconfigs/#deprecated_easyconfigs_toolchains). + +## Supported CPU targets + +The software *should* work on all [CPU targets supported by EESSI](cpu_targets.md). + +Exceptions to this requirement are allowed if technical problems that can not be resolved with reasonable effort +prevent the installation of the software for specific CPU targets. + +## Software versions & toolchains + +Recent software versions and toolchains *should* be preferred, +although the installation of older versions of use of older toolchains is allowed if sufficiently motivated. + +## Testing + +We should be able to test the software installations via the [EESSI test suite](https://github.com/EESSI/test-suite) +being developed. + +Ideally one or more tests are available that verify that the software is functionally correct, +and performs well. + +It should be possible to run a minimal *smoke test*, for example using EasyBuild's `--sanity-check-only` feature. + +!!! note + + The [EESSI test suite](https://github.com/EESSI/test-suite) is still in active development, + and currently only has a minimal set of tests available. + + When the test suite is more mature, this requirement will be enforced more strictly. diff --git a/mkdocs.yml b/mkdocs.yml index e9112f689..22ede35c0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,6 +26,7 @@ nav: - software_layer/cpu_targets.md - software_layer/build_nodes.md - software_layer/adding_software.md + - software_layer/contribution_policy.md - Build-test-deploy bot: bot.md - Pilot repository: pilot.md - Getting access to EESSI: From 3e25c0809e0e378cc815ba50b9841e813da809d6 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Tue, 24 Oct 2023 11:10:53 +0200 Subject: [PATCH 2/8] tweak initial contribution policy based on provided feedback --- .../contribution_policy.md | 72 +++++++++++++------ docs/index.md | 1 + docs/software_layer/adding_software.md | 2 +- mkdocs.yml | 2 +- 4 files changed, 55 insertions(+), 22 deletions(-) rename docs/{software_layer => }/contribution_policy.md (60%) diff --git a/docs/software_layer/contribution_policy.md b/docs/contribution_policy.md similarity index 60% rename from docs/software_layer/contribution_policy.md rename to docs/contribution_policy.md index d90bee229..73f54925f 100644 --- a/docs/software_layer/contribution_policy.md +++ b/docs/contribution_policy.md @@ -1,17 +1,29 @@ # Contribution policy -When [openining a pull request to add software to EESSI](adding_software.md), the following requirements must -be taken into account. +*(version v0.1.0 - updated 24 Oct 2023)* !!! note - These requirements are subject to change, please check back regularly. + This policy is subject to change, please check back regularly. -## Open source software +## Purpose + +The purpose of this contribution policy is to provide guidelines for [adding software](software_layer/adding_software.md) to EESSI. + +It informs about what requirements must be met in order for software to be eligible for inclusion +in the EESSI software layer. + +## Requirements + +The following requirements must be taken into account when adding software to EESSI. + +--- + +### a) Open source software { #open_source_software } Only **open source software** can be added to the EESSI repository. -Make sure that you are aware of software license, and that redistribution is allowed. +Make sure that you are aware of relevant software license, and that redistribution is allowed. For more information about a specific license, see the [SPDX license list](https://spdx.org/licenses/). @@ -20,12 +32,18 @@ For more information about a specific license, see the [SPDX license list](https We intend to automatically verify that this requirement is met, by requiring that the [SPDX license identifier](https://spdx.dev/ids/) is provided for all software. -## Built by the bot -All software included in the EESSI repository *must* be built autonomously by [our bot :robot:](../bot.md), -see also the [semi-automatic software installation procedure](adding_software.md). +--- -## Supported by EasyBuild +### b) Built by the bot { #built_by_bot } + +All software included in the EESSI repository *must* be built autonomously by [our bot :robot:](bot.md), +see also the [semi-automatic software installation procedure](software_layer/adding_software.md). + + +--- + +### c) Supported by EasyBuild { #supported_by_easybuild } Currently, we require that all software being added to EESSI is supported by the *EasyBuild release* being used to perform the installation. @@ -37,32 +55,38 @@ We do allow the use of [`--from-pr`](https://docs.easybuild.io/integration-with- to pull in changes required to make the installation work correctly in the EESSI build environment, but only if that is strictly required. -!!! note - This restriction may be relaxed later to also allow adding software that is not supported yet in the latest - EasyBuild release, or to allow for installing software with other tools. +--- -## Supported compiler toolchains +### d) Compiler toolchain { #compiler_toolchain } A [compiler toolchain](https://docs.easybuild.io/terminology/#toolchains) that is still supported by the latest EasyBuild must be used for building the software. -More information on deprecated toolchains in EasyBuild is available -[here](https://docs.easybuild.io/deprecated-easyconfigs/#deprecated_easyconfigs_toolchains). +More information on supported toolchains in EasyBuild is available [here](https://docs.easybuild.io/policies/toolchains). -## Supported CPU targets -The software *should* work on all [CPU targets supported by EESSI](cpu_targets.md). +--- + +### e) CPU targets { #cpu_targets } + +The software *should* work on all [CPU targets supported by EESSI](software_layer/cpu_targets.md). Exceptions to this requirement are allowed if technical problems that can not be resolved with reasonable effort prevent the installation of the software for specific CPU targets. -## Software versions & toolchains + +--- + +### f) Versions & toolchains { #versions_toolchains } Recent software versions and toolchains *should* be preferred, -although the installation of older versions of use of older toolchains is allowed if sufficiently motivated. +although the installation of older software versions and toolchains is allowed if sufficiently motivated. + -## Testing +--- + +### g) Testing { #testing } We should be able to test the software installations via the [EESSI test suite](https://github.com/EESSI/test-suite) being developed. @@ -78,3 +102,11 @@ It should be possible to run a minimal *smoke test*, for example using EasyBuild and currently only has a minimal set of tests available. When the test suite is more mature, this requirement will be enforced more strictly. + +--- + +## Changelog + +### v0.1.0 (24 Oct 2023) + +- initial contribution policy diff --git a/docs/index.md b/docs/index.md index 88f816007..2ffdb17b6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,6 +18,7 @@ More details about the project are available in the different subsections: * [Filesystem layer](filesystem_layer.md) * [Compatibility layer](compatibility_layer.md) * [Software layer](software_layer.md) +* [Contribution policy](contribution_policy.md) * [Pilot repository](pilot.md) * [Getting access to EESSI](getting_access/is_eessi_accessible.md) * [Using EESSI](using_eessi/setting_up_environment.md) diff --git a/docs/software_layer/adding_software.md b/docs/software_layer/adding_software.md index e08d67097..b8ebb52f7 100644 --- a/docs/software_layer/adding_software.md +++ b/docs/software_layer/adding_software.md @@ -11,7 +11,7 @@ To add software to EESSI, you should go through the semi-automatic software inst !!! warning - Make sure you are also aware of our [contribution policy](contribution_policy.md) when adding software to EESSI. + Make sure you are also aware of our [contribution policy](../contribution_policy.md) when adding software to EESSI. ### Preparation diff --git a/mkdocs.yml b/mkdocs.yml index 22ede35c0..b27a1326d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,7 +26,7 @@ nav: - software_layer/cpu_targets.md - software_layer/build_nodes.md - software_layer/adding_software.md - - software_layer/contribution_policy.md + - Contribution policy: contribution_policy.md - Build-test-deploy bot: bot.md - Pilot repository: pilot.md - Getting access to EESSI: From 00bb6dfe4a8c4b44543081a84bb34dba99d5614b Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Tue, 24 Oct 2023 11:14:16 +0200 Subject: [PATCH 3/8] link to test-suite section in contribution policy --- docs/contribution_policy.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/contribution_policy.md b/docs/contribution_policy.md index 73f54925f..ea40892b5 100644 --- a/docs/contribution_policy.md +++ b/docs/contribution_policy.md @@ -88,8 +88,7 @@ although the installation of older software versions and toolchains is allowed i ### g) Testing { #testing } -We should be able to test the software installations via the [EESSI test suite](https://github.com/EESSI/test-suite) -being developed. +We should be able to test the software installations via the [EESSI test suite](../test-suite). Ideally one or more tests are available that verify that the software is functionally correct, and performs well. From 86f99c37cbd38e2dbd1adf2b86e76f17fff529b9 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 9 Nov 2023 16:25:44 +0100 Subject: [PATCH 4/8] rework v0.1.0 of contribution policy based on provided feedback --- docs/contribution_policy.md | 94 ++++++++++++++++++++++++------------- 1 file changed, 62 insertions(+), 32 deletions(-) diff --git a/docs/contribution_policy.md b/docs/contribution_policy.md index ea40892b5..8db0ffe71 100644 --- a/docs/contribution_policy.md +++ b/docs/contribution_policy.md @@ -1,6 +1,6 @@ # Contribution policy -*(version v0.1.0 - updated 24 Oct 2023)* +*(version v0.1.0 - updated 9 Nov 2023)* !!! note @@ -17,83 +17,113 @@ in the EESSI software layer. The following requirements must be taken into account when adding software to EESSI. +Note that additional restrictions may apply in specific cases that are currently not covered explicitly by this policy. + --- -### a) Open source software { #open_source_software } +### i) Open source software { #open_source_software } -Only **open source software** can be added to the EESSI repository. +Only **freely redistributable software** can be added to the EESSI repository, +and we strongly prefer including only **open source software** in EESSI. -Make sure that you are aware of relevant software license, and that redistribution is allowed. +Make sure that you are aware of the relevant software licenses, +and that redistribution of the software you want to add to EESSI is allowed. -For more information about a specific license, see the [SPDX license list](https://spdx.org/licenses/). +For more information about a specific software license, +see the [SPDX license list](https://spdx.org/licenses/). !!! note We intend to automatically verify that this requirement is met, - by requiring that the [SPDX license identifier](https://spdx.dev/ids/) is provided for all software. + by requiring that the [SPDX license identifier](https://spdx.dev/ids/) is provided + for all software included in EESSI. --- -### b) Built by the bot { #built_by_bot } +### ii) Built by the bot { #built_by_bot } + +All software included in the EESSI repository *must* be **built autonomously** by [our bot :robot:](bot.md). -All software included in the EESSI repository *must* be built autonomously by [our bot :robot:](bot.md), -see also the [semi-automatic software installation procedure](software_layer/adding_software.md). +For more information, see our [semi-automatic software installation procedure](software_layer/adding_software.md). --- -### c) Supported by EasyBuild { #supported_by_easybuild } +### iii) Built and installed with EasyBuild { #easybuild } -Currently, we require that all software being added to EESSI is supported by the *EasyBuild release* being used -to perform the installation. +We currently require that all software installations in EESSI are +**built and installed using EasyBuild**. -That is, the easyconfig files used for the installation *must be included in the EasyBuild release*. +We strongly prefer that the [*latest release of EasyBuild*](https://pypi.org/project/easybuild/) +that is available at the time is used to add software to EESSI. -We do allow the use of [`--from-pr`](https://docs.easybuild.io/integration-with-github/#github_from_pr) and +The use of [`--from-pr`](https://docs.easybuild.io/integration-with-github/#github_from_pr) and [`--include-easyblocks-from-pr`](https://docs.easybuild.io/integration-with-github/#github_include_easyblocks_from_pr) -to pull in changes required to make the installation work correctly in the EESSI build environment, -but only if that is strictly required. +to pull in changes to EasyBuild that are required to make the installation work correctly +in EESSI is allowed, but only if that is strictly required +(that is, if those changes are not included yet in the latest EasyBuild release). --- -### d) Compiler toolchain { #compiler_toolchain } +### iv) Supported compiler toolchain { #supported_toolchain } -A [compiler toolchain](https://docs.easybuild.io/terminology/#toolchains) that is still supported by the latest -EasyBuild must be used for building the software. +A **[compiler toolchain](https://docs.easybuild.io/terminology/#toolchains) that is still supported** +by the latest EasyBuild release *must* be used for building the software. -More information on supported toolchains in EasyBuild is available [here](https://docs.easybuild.io/policies/toolchains). +For more information on supported toolchains, +see the [EasyBuild toolchain support policy](https://docs.easybuild.io/policies/toolchains). --- -### e) CPU targets { #cpu_targets } +### v) Recent toolchain versions { #recent_toolchains } -The software *should* work on all [CPU targets supported by EESSI](software_layer/cpu_targets.md). +We strongly prefer adding software to EESSI that was built with a **recent compiler toolchain**. -Exceptions to this requirement are allowed if technical problems that can not be resolved with reasonable effort -prevent the installation of the software for specific CPU targets. +When adding software to a particular version of EESSI, +you should *use a toolchain version that is already installed*. + +If you would like to see an additional toolchain version being added to a particular version of EESSI, +please [open a support request](support.md) for this, and motivate your request. + +--- + +### vi) Recent software versions { #recent_software_versions } + +We strongly prefer adding sufficiently **recent software versions** to EESSI. + +If you would like to add older software versions, please clearly motivate the need for this +in your contribution. --- -### f) Versions & toolchains { #versions_toolchains } +### vii) CPU targets { #cpu_targets } -Recent software versions and toolchains *should* be preferred, -although the installation of older software versions and toolchains is allowed if sufficiently motivated. +Software that is added to EESSI *should* **work on all [supported CPU targets](software_layer/cpu_targets.md)**. + +Exceptions to this requirement are allowed if technical problems that can not be resolved with reasonable effort +prevent the installation of the software for specific CPU targets. --- -### g) Testing { #testing } +### viii) Testing { #testing } -We should be able to test the software installations via the [EESSI test suite](../test-suite). +We should be able to test the software installations via the [EESSI test suite](../test-suite), +in particular for software applications and user-facing tools. Ideally one or more tests are available that verify that the software is functionally correct, -and performs well. +and that it (still) performs well. + +Tests that are run during the software installation procedure as performed by EasyBuild *must* pass. +Exceptions can made if only a small subset of tests fail for specific CPU targets, +as long as these exceptions are tracked and an effort is made to assess the impact of those failing tests. -It should be possible to run a minimal *smoke test*, for example using EasyBuild's `--sanity-check-only` feature. +It should be possible to run a minimal *smoke test* for the software included in EESSI, +for example using EasyBuild's `--sanity-check-only` feature. !!! note @@ -106,6 +136,6 @@ It should be possible to run a minimal *smoke test*, for example using EasyBuild ## Changelog -### v0.1.0 (24 Oct 2023) +### v0.1.0 (9 Nov 2023) - initial contribution policy From 4d00501f9b9aba70f8a7891647e736a686b1d7c4 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 9 Nov 2023 18:04:05 +0100 Subject: [PATCH 5/8] "It informs contributors" Co-authored-by: ocaisa --- docs/contribution_policy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribution_policy.md b/docs/contribution_policy.md index 8db0ffe71..8b25deab2 100644 --- a/docs/contribution_policy.md +++ b/docs/contribution_policy.md @@ -10,7 +10,7 @@ The purpose of this contribution policy is to provide guidelines for [adding software](software_layer/adding_software.md) to EESSI. -It informs about what requirements must be met in order for software to be eligible for inclusion +It informs contributors about what requirements must be met in order for software to be eligible for inclusion in the EESSI software layer. ## Requirements From 5b4240f4d8172ccf64aaaaa25937eec3b38fc81f Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 9 Nov 2023 18:13:57 +0100 Subject: [PATCH 6/8] fix links to other docs pages --- docs/adding_software/contribution_policy.md | 12 ++++++------ docs/adding_software/opening_pr.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/adding_software/contribution_policy.md b/docs/adding_software/contribution_policy.md index 8b25deab2..8609412fc 100644 --- a/docs/adding_software/contribution_policy.md +++ b/docs/adding_software/contribution_policy.md @@ -8,9 +8,9 @@ ## Purpose -The purpose of this contribution policy is to provide guidelines for [adding software](software_layer/adding_software.md) to EESSI. +The purpose of this contribution policy is to provide guidelines for [adding software](opening_pr.md) to EESSI. -It informs contributors about what requirements must be met in order for software to be eligible for inclusion +It informs about what requirements must be met in order for software to be eligible for inclusion in the EESSI software layer. ## Requirements @@ -43,9 +43,9 @@ see the [SPDX license list](https://spdx.org/licenses/). ### ii) Built by the bot { #built_by_bot } -All software included in the EESSI repository *must* be **built autonomously** by [our bot :robot:](bot.md). +All software included in the EESSI repository *must* be **built autonomously** by [our bot :robot:](../bot.md). -For more information, see our [semi-automatic software installation procedure](software_layer/adding_software.md). +For more information, see our [semi-automatic software installation procedure](building_software.md). --- @@ -86,7 +86,7 @@ When adding software to a particular version of EESSI, you should *use a toolchain version that is already installed*. If you would like to see an additional toolchain version being added to a particular version of EESSI, -please [open a support request](support.md) for this, and motivate your request. +please [open a support request](../support.md) for this, and motivate your request. --- @@ -112,7 +112,7 @@ prevent the installation of the software for specific CPU targets. ### viii) Testing { #testing } -We should be able to test the software installations via the [EESSI test suite](../test-suite), +We should be able to test the software installations via the [EESSI test suite](../test-suite/index.md), in particular for software applications and user-facing tools. Ideally one or more tests are available that verify that the software is functionally correct, diff --git a/docs/adding_software/opening_pr.md b/docs/adding_software/opening_pr.md index 60601be57..0603966e3 100644 --- a/docs/adding_software/opening_pr.md +++ b/docs/adding_software/opening_pr.md @@ -13,7 +13,7 @@ To add software to EESSI, you should go through the semi-automatic software inst !!! warning - Make sure you are also aware of our [contribution policy](../contribution_policy.md) when adding software to EESSI. + Make sure you are also aware of our [contribution policy](contribution_policy.md) when adding software to EESSI. ### Preparation From c580bfda101f25deb21772351739613deb46e4b0 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 9 Nov 2023 18:35:26 +0100 Subject: [PATCH 7/8] fix more links to other docs pages, consistently use .md in links to other docs pages --- docs/adding_software/contribution_policy.md | 2 +- docs/getting_access/eessi_container.md | 4 ++-- docs/getting_access/is_eessi_accessible.md | 10 +++++----- docs/getting_access/native_installation.md | 2 +- docs/index.md | 1 - docs/overview.md | 2 +- docs/test-suite/index.md | 2 +- docs/using_eessi/eessi_demos.md | 2 +- 8 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/adding_software/contribution_policy.md b/docs/adding_software/contribution_policy.md index 8609412fc..816b8f81f 100644 --- a/docs/adding_software/contribution_policy.md +++ b/docs/adding_software/contribution_policy.md @@ -102,7 +102,7 @@ in your contribution. ### vii) CPU targets { #cpu_targets } -Software that is added to EESSI *should* **work on all [supported CPU targets](software_layer/cpu_targets.md)**. +Software that is added to EESSI *should* **work on all [supported CPU targets](../software_layer/cpu_targets.md)**. Exceptions to this requirement are allowed if technical problems that can not be resolved with reasonable effort prevent the installation of the software for specific CPU targets. diff --git a/docs/getting_access/eessi_container.md b/docs/getting_access/eessi_container.md index 78b9b1f5f..04c73c867 100644 --- a/docs/getting_access/eessi_container.md +++ b/docs/getting_access/eessi_container.md @@ -53,7 +53,7 @@ Apptainer> beginning with `CernVM-FS: ` have been printed after the first prompt `Apptainer> ` was shown. -To start using EESSI, see [Using EESSI/Setting up your environment](../../using_eessi/setting_up_environment). +To start using EESSI, see [Using EESSI/Setting up your environment](../using_eessi/setting_up_environment.md). ## Help for `eessi_container.sh` @@ -346,7 +346,7 @@ parsing command line arguments. For example, ## Running EESSI demos For examples of scripts that use the software provided by EESSI, -see [Running EESSI demos](../../using_eessi/eessi_demos). +see [Running EESSI demos](../using_eessi/eessi_demos.md). ## Launching containers more quickly Subsequent runs of `eessi_container.sh` may reuse temporary data of a previous diff --git a/docs/getting_access/is_eessi_accessible.md b/docs/getting_access/is_eessi_accessible.md index 8dc013ae4..218e8219b 100644 --- a/docs/getting_access/is_eessi_accessible.md +++ b/docs/getting_access/is_eessi_accessible.md @@ -1,7 +1,7 @@ # Is EESSI accessible? -EESSI can be accessed via [a native (CernVM-FS) installation](../native_installation), -or via [a container that includes CernVM-FS](../eessi_container). +EESSI can be accessed via [a native (CernVM-FS) installation](native_installation.md), +or via [a container that includes CernVM-FS](eessi_container.md). Before you look into these options, check if EESSI is already accessible on your system. @@ -21,7 +21,7 @@ host_injections latest versions ``` For starting to use EESSI, continue reading about -[Setting up environment](../../using_eessi/setting_up_environment). +[Setting up environment](../using_eessi/setting_up_environment.md). If you see an error message as shown below, **EESSI is not yet accessible on your system**. @@ -30,5 +30,5 @@ ls: /cvmfs/pilot.eessi-hpc.org: No such file or directory ``` No worries, you don't need to be a :mage: to get access to EESSI. -Continue reading about the [Native installation](../native_installation) of EESSI, -or access via the [EESSI container](../eessi_container). +Continue reading about the [Native installation](native_installation.md) of EESSI, +or access via the [EESSI container](eessi_container.md). diff --git a/docs/getting_access/native_installation.md b/docs/getting_access/native_installation.md index 47380fb35..b5cd197f0 100644 --- a/docs/getting_access/native_installation.md +++ b/docs/getting_access/native_installation.md @@ -1,7 +1,7 @@ # Native installation Setting up native access to EESSI, that is a system-wide deployment that does not require workarounds like -[using a container](../eessi_container), requires the installation and configuration of [CernVM-FS](https://cernvm.cern.ch/fs). +[using a container](eessi_container.md), requires the installation and configuration of [CernVM-FS](https://cernvm.cern.ch/fs). This requires **admin privileges**, since you need to install CernVM-FS as an OS package. diff --git a/docs/index.md b/docs/index.md index c098ee68a..c4ce02bc3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,6 @@ More details about the project are available in the different subsections: * [Filesystem layer](filesystem_layer.md) * [Compatibility layer](compatibility_layer.md) * [Software layer](software_layer.md) -* [Contribution policy](contribution_policy.md) * [Pilot repository](pilot.md) * [Getting access to EESSI](getting_access/is_eessi_accessible.md) * [Using EESSI](using_eessi/setting_up_environment.md) diff --git a/docs/overview.md b/docs/overview.md index bb75c783d..d1212c152 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -34,7 +34,7 @@ The EESSI project consists of 3 layers. ![EESSI overview](img/overview_layers.png) -The bottom layer is the [**filesystem layer**](filesystem_layer), +The bottom layer is the [**filesystem layer**](filesystem_layer.md), which is responsible for distributing the software stack across clients. The middle layer is a [**compatibility layer**](compatibility_layer.md), diff --git a/docs/test-suite/index.md b/docs/test-suite/index.md index be67c25d8..2d7f1ca80 100644 --- a/docs/test-suite/index.md +++ b/docs/test-suite/index.md @@ -2,7 +2,7 @@ The [EESSI test suite](https://github.com/EESSI/test-suite) is a collection of tests that are run using [ReFrame](https://reframe-hpc.readthedocs.io/). -It is used to check whether the software installations included in the [EESSI software layer](../software_layer) +It is used to check whether the software installations included in the [EESSI software layer](../software_layer.md) are working and performing as expected. To get started, you should look into the [installation and configuration guidelines](installation-configuration.md) first. diff --git a/docs/using_eessi/eessi_demos.md b/docs/using_eessi/eessi_demos.md index d9cc7e4b4..598480940 100644 --- a/docs/using_eessi/eessi_demos.md +++ b/docs/using_eessi/eessi_demos.md @@ -36,7 +36,7 @@ even with limited resources only. Let's try running the GROMACS example. -First, we need to make sure that [our environment is set up to use EESSI](../setting_up_environment): +First, we need to make sure that [our environment is set up to use EESSI](setting_up_environment.md): ``` { .bash .copy } source /cvmfs/pilot.eessi-hpc.org/latest/init/bash From cef6f85b038c47c1eea5025e76734429c008b859 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 9 Nov 2023 20:46:53 +0100 Subject: [PATCH 8/8] fix typo MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Thomas Röblitz --- docs/adding_software/contribution_policy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adding_software/contribution_policy.md b/docs/adding_software/contribution_policy.md index 816b8f81f..a4a4d5c4f 100644 --- a/docs/adding_software/contribution_policy.md +++ b/docs/adding_software/contribution_policy.md @@ -119,7 +119,7 @@ Ideally one or more tests are available that verify that the software is functio and that it (still) performs well. Tests that are run during the software installation procedure as performed by EasyBuild *must* pass. -Exceptions can made if only a small subset of tests fail for specific CPU targets, +Exceptions can be made if only a small subset of tests fail for specific CPU targets, as long as these exceptions are tracked and an effort is made to assess the impact of those failing tests. It should be possible to run a minimal *smoke test* for the software included in EESSI,