Merge pull request #1 from branfosj/eb5

planned and proposed changes for EB5, and py2vs3 info, deprecation warning for .yeb

docs/easybuild-v5/overview-of-changes.md

@@ -1,20 +1,46 @@
 # Overview of changes in EasyBuild version 5.0 {: #overview }
 
+!!! warning
+    EasyBuild 5.0 is currently still under development, via the `5.0.x` branches in the EasyBuild GitHub repositories.
+
+    We intend to update this page regularly as the [planned changes][eb5_plans] are being implemented and when there
+    are [proposed changes][eb5_proposals] where we are requesting community feedback.
+
 This page provides a concise overview of the most prominent changes in EasyBuild version 5.0,
 which can be categorized as:
 
 * [Significant enhancements][significant_enhancements]
 * [Backward-incompatible changes][backwards_incompatible]
-* [Deprecated functionality][deprecated]
+* [Deprecated functionality][deprecated_v5]
 
 For in-depth details on a particular change, see the pull requests that are linked from each of the subsections below.
 
-!!! warning
+---
 
-    EasyBuild 5.0 is currently still under development, via the `5.0.x` branches in the EasyBuild GitHub repositories.
+## Planned and proposed changes for EasyBuild v5.0 {: #eb5_changes }
+
+At the [EasyBuild User Meetin](https://easybuild.io/eum23), Simon Branford set out the
+[roadmap for EasyBuild v5.0](https://easybuild.io/eum23/#easybuild5).
+
+### Proposed changes for EasyBuild v5.0 {: #eb5_proposals }
 
-    We intend to update this page regularly as the planned changes are being implemented.
+There are several proposed changes where the EasyBuild maintainers are seeking community feedback. If you wish to provide
+feedback then please comment in the GitHub issue for the proposal.
 
+* Minimum supported Lmod Version: _proposal forthcoming_
+* Toolchain Support Policy: _proposal forthcoming_
+
+### Planned changes for EasyBuild v5.0 {: #eb5_plans }
+
+* [enable `--trace` by default](https://github.com/easybuilders/easybuild-framework/pull/4250)
+
+!!! note
+    This list is the major planned changes. It is not intended to be a complete list of all changes that are
+    planned for EasyBuild v5.0.
+
+### Tracking development of EasyBuild v5.0
+
+* [GitHub Project board for EasyBuild v5.0](https://github.com/orgs/easybuilders/projects/18)
 
 ---
 
@@ -43,7 +69,8 @@ EasyBuild 5.0 requires Python >= 3.6 to run.
 Running EasyBuild with Python 2.7 or a Python 3 version older than Python 3.6 is no longer supported.
 
 Trying to run EasyBuild with a Python version that is too old will result in an error:
-```
+
+```log
 ERROR: No compatible 'python' command found via $PATH (EasyBuild requires Python 3.6+)
 ```
 
@@ -68,17 +95,20 @@ has been deprecated ([see also below][py2vs3]).
 
 ### Deprecated EasyBuild bootstrap script is removed {: #bootstrap_script }
 
-[easybuild-framework PR #4233](https://github.com/easybuilders/easybuild-framework/pull/4233)
+The EasyBuild bootstrap script has been removed (see [easybuild-framework PR #4233](https://github.com/easybuilders/easybuild-framework/pull/4233)).
+Please see the [installation page][installation] for the suggested methods for installing EasyBuild.
 
 ---
 
 ### Experimental support for the .yeb easyconfig format is removed {: #yeb }
 
-[easybuild-framework PR #4237](https://github.com/easybuilders/easybuild-framework/pull/4237)
+Support for the experimental `.yeb` easyconfig format has been removed (see [easybuild-framework PR #4237](https://github.com/easybuilders/easybuild-framework/pull/4237)).
+This format allowed easyconfigs to be specified in YAML. However, there has been no recent development of this
+format and little suggestion that anyone was using it.
 
 ---
 
-## Deprecated functionality in EasyBuild v5.0 {: #deprecated }
+## Deprecated functionality in EasyBuild v5.0 {: #deprecated_v5 }
 
 Some functionality is being deprecated in EasyBuild v5.0, and will no longer be supported in EasyBuild v6.0:
 
@@ -91,3 +121,34 @@ If you trigger any deprecated functionality, a warning message will be printed.
 ### `easybuild.tools.py2vs3` module {: #py2vs3 }
 
 [easybuild-framework PR #4229](https://github.com/easybuilders/easybuild-framework/pull/4229)
+
+The following table lists the changes required to replace imports from the the `py2vs3` module.
+
+| `from easybuild.tools.py2vs3 import ...` | Replacement |
+|--|--|
+| `ascii_letters` | `from string import ascii_letters` |
+| `ascii_lowercase` | `from string import ascii_lowercase` |
+| `build_opener` | `from urllib.request import build_opener` |
+| `ConfigParser` | `from configparser import ConfigParser` |
+| `configparser` | `import configparser` |
+| `create_base_metaclass` | `from easybuild.base.wrapper import create_base_metaclass` |
+| `extract_method_name` | No import required. Replace `extract_method_name(method)` with `'_'.join(method.__code__.co_names)` |
+| `HTMLParser` | `from html.parser import HTMLParser` |
+| `HTTPError` | `from urllib.request import HTTPError` |
+| `HTTPSHandler` | `from urllib.request import HTTPSHandler` |
+| `json_loads` | `from json import loads` and rename `json_loads` to `loads` |
+| `Mapping` | `from collections.abc import Mapping` |
+| `mk_wrapper_baseclass` | `from easybuild.base.wrapper import mk_wrapper_baseclass` |
+| `OrderedDict` | `from collections import OrderedDict` |
+| `raise_with_traceback` | No import required. Replace `raise_with_traceback(exception, message, tb)` with `raise exception(message).with_traceback(tb)` |
+| `reload` | `from importlib import reload` |
+| `Request` | `from urllib.request import Request` |
+| `string_type` | No import required. Use `str` directly. |
+| `StringIO` | `from io import StringIO` |
+| `std_urllib` | `import urllib.request as std_urllib` |
+| `subprocess_popen_text` | `from easybuild.tools.run import subprocess_popen_text` |
+| `subprocess_terminate` | `from easybuild.tools.run import subprocess_terminate` |
+| `urlencode` | `from urllib.parse import urlencode` |
+| `URLError` | `from urllib.request import URLError` |
+| `urlopen` | `from urllib.request import urlopen` |
+

docs/writing-yeb-easyconfig-files.md

@@ -1,12 +1,7 @@
-# Writing easyconfig files in YAML syntax (`.yeb` format) **[IN DEVELOPMENT]** {: #easyconfig_yeb_format }
+# Writing easyconfig files in YAML syntax (`.yeb` format) **Deprecated** {: #easyconfig_yeb_format }
 
-!!! note
-    Because support for easyconfig files in YAML syntax (a.k.a. `.yeb` files) is still *in development*,
-    using them currently requires enabling the use of experimental features (`--experimental`),
-    see also [Experimental features][experimental_features].
-
-    An up-to-date overview of current progress on support for `.yeb` easyconfigs is available at
-    <https://github.com/easybuilders/easybuild-framework/issues/1407>.
+!!! warning
+    Use of `.yeb` easyconfigs is deprecated and [will be removed in EasyBuild v5.0][yeb].
 
 Useful links: