Dear EasyBuilders,
I'm pleased to announce that the migration of the EasyBuild
documentation to MarkDown + MkDocs has been completed.
This effort has been discussed for a long time, and was finally
kickstarted in October 2022.
It's the first major revamp of the EasyBuild documentation since it was
created in
The EasyBuild documentation at https://docs.easybuild.io now has a very
different look, is better organised, and has a significantly better
search function.
The documentation sources in MarkDown are located in a dedicated
repository at https://github.com/easybuilders/easybuild-docs .
The content is largely identical to the "old" documentation (which was
rendered using Sphinx, with the .rst sources located in the 'docs'
subdirectory of the https://github.com/easybuilders/easybuild repository).
However, we hope that completing this migration can be the starting
point for thoroughly revising, updating, and extending the EasyBuild
documentation.
Automatic redirects have been put in place to try and ensure that you
won't run into any broken links, even if they still point to the old
structure of the documentation, or use an outdated URL that starts with
'https://easybuild.readthedocs.io/' .
The EasyBuild tutorial (https://tutorial.easybuild.io) is currently
still a separate website - we may integrate that into the EasyBuild
documentation (since both are rendered with MkDocs).
Thanks a lot to Simon Branford and James Carpenter, both from the
University of Birmingham, for their extensive involvement in this
migration effort, as well as to anyone else who has contributed to it
(directly or indirectly).
If you notice any problems, or have some suggestions for
changes/enhancments, please report them via
https://github.com/easybuilders/easybuild-docs/issues, or open a pull
request.
regards,
Kenneth
