Skip to content

Commit

Permalink
Merge pull request #11 from Lumi-supercomputer/feature/whats-new
Browse files Browse the repository at this point in the history
Add a "What's new" section and release tag to the first screen.
  • Loading branch information
klust authored Dec 15, 2023
2 parents f797202 + bb0f8d3 commit ba73fe7
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/manual-deploy-main-tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ jobs:
# We do a build first to ensure that building works as expected.
# We don't use --strict as we do want to ignore some warnings.
run: |
cd LUMI-EasyBuild-docs && make build
cd LUMI-EasyBuild-docs && make build TAG=${{ inputs.use_tag }}
- name: deploy docs
run: |
cd LUMI-EasyBuild-docs && make deploy-origin
cd LUMI-EasyBuild-docs && make deploy-origin TAG=${{ inputs.use_tag }}
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Note: call as "make serve" or "make preview" to get the "Last processed" line,
# or "make serve TAG=<mytag>"etc. to get the line "RElease: <mytag>" instead.
#
all: preview

gendoc = docs-generated
Expand All @@ -7,7 +11,7 @@ clean-gen:
/bin/rm -rf $(gendoc)

rebuild-gen:
$(buildscript)
$(buildscript) $(TAG)

build: clean-gen rebuild-gen
mkdocs build --config-file $(gendoc)/mkdocs.yml
Expand Down
43 changes: 43 additions & 0 deletions docs/whats_new.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Known issues with the LUMI software stacks
hide:
- navigation
---

# What's new in the LUMI software stack

## Release 20231215

- [rocm/5.6.1](r/rocm/index.md) and [amd/5.6.1](a/amd/index.md)
modules installed in `CrayEnv` and `LUMI/23.09 partition/G`.
- Updated user-installable recipes for Java, including [Java/21](j/Java/index.md).
- User-installable recipe for the [UNICORE UFTP client](u/unicore-uftp/index.md).
- User-installable recipe for the installation of [SIESTA (CPU version)](s/Siesta/index.md)


## Release 20231208

- [GROMACS](g/GROMACS/index.md) with [hipSYCL](h/hipSYCL/index.md) and dependencies, including a version with heFFT.
- [nvtop](n/nvtop/index.md)
- Extra user-installable version of [SCOTCH](s/SCOTCH/index.md) (64-bit integers)
- Update of the [aws-ofi-rccl plugin](a/aws-ofi-rccl/index.md)
- Fix for [ELPA](e/ELPA/index.md)
- Improved [Open MPI](o/OpenMPI/index.md) with [OSU micro-benchmarks](o/OSU-Micro-Benchmarks/index.md)
as test code and user-installable adapted versions of [lumi-CPEtools](l/lumi-CPEtools/index.md)
for checking task and thread distribution and pinning.


## Release 20231121

- Bug fixes for the module view
- More container recipes


## Release 20231116

- Initial release of the `LUMI/23.09` central software stack, including a first
selection of user-installable build recipes
- Initial support for creating modules that ease working with containers
provided on LUMI.
- New version of the [cotainr](c/cotainr/index.md) module
- Bug fix for the `lumi-ldap-projectinfo` command.
12 changes: 10 additions & 2 deletions scripts/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ container_archived_module_preamble="This software is archived in the\n\
[easybuild/easyconfigs/\_\_archive\_\_/<file_with_prefix>](https://github.com/Lumi-supercomputer/LUMI-EasyBuild-contrib/blob/main/easybuild/easyconfigs/__archive__/<file_with_prefix>).\n\
The corresponding module would be <name>/<version>. The containers are likely no longer available on LUMI though."
other_info_label="Issues"
whatsnew_label="New"

>&2 echo "Working in repo $repo in $repodir."

Expand Down Expand Up @@ -127,7 +128,13 @@ prefix_other="$repodir/docs/other_packages"
package_list="$gendoc/docs/index.md"

echo -e "---\ntitle: Package overview\nhide:\n- navigation\n---\n" >$package_list
echo -e "# Package list\n" >>$package_list
echo -e "# Package list\n" >> $package_list
if (( $# == 1 ))
then
echo -e "Lumi software stack release: $1\n" >> $package_list
else
echo -e "Last processed: $(date -u)\n" >> $package_list
fi
echo -e "<span class='lumi-software-smallbutton-userdoc'></span>: Specific user documentation available\n" >> $package_list
echo -e "<span class='lumi-software-smallbutton-techdoc'></span>: Technical documentation available\n" >> $package_list
echo -e "<span class='lumi-software-smallbutton-archive'></span>: Archived application\n" >> $package_list
Expand Down Expand Up @@ -971,7 +978,8 @@ do
done

#
# Add a navigation item for the other information such as issues.
# Add a navigation items for the other information such as issues and what's new.
#

echo "- $other_info_label: known_issues.md" >>$gendoc/mkdocs.yml
echo "- $whatsnew_label: whats_new.md" >>$gendoc/mkdocs.yml

0 comments on commit ba73fe7

Please sign in to comment.