Skip to content

Commit 645fd83

Browse files
authored
Add a more useful landing page
1 parent bffd194 commit 645fd83

File tree

1 file changed

+6
-93
lines changed

1 file changed

+6
-93
lines changed

README.md

Lines changed: 6 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,11 @@
1-
[use]: https://github.com/Andre601/mkdocs-template/generate
1+
# MultiXscale, a EuroHPC Centre of Excellence
22

3-
[MkDocs]: https://www.mkdocs.org/
3+
<p align="center"><img src="img/multixscale_logo.png" alt="MultiXscale logo" width="500px"/></p>
44

5-
[squidfunk]: https://github.com/squidfunk
6-
[MkDocs Material Theme]: https://github.com/squidfunk/mkdocs-material
5+
MultiXscale, a EuroHPC Centre of Excellence (CoE), is a new large-scale international project funded by the European Commission and the EuroHPC Joint Undertaking. It will extend the applications, user-base and domains actively engaged in the current CoE and EuroHPC ecosystem by addressing specific and critical needs, and advancing the transition towards use of exascale resources by scientific and industrial users in the community of multiscale modelling. This 4-year research project started on the 1st January 2023 and comprises a consortium of 15 partners, including European world-renowned research institutions and companies.
76

8-
[facelessuser]: https://github.com/facelessuser
9-
[PyMdown Extensions]: https://github.com/facelessuser/pymdown-extensions/
7+
The technical aspect of MultiXscale will help mature the European Environment for Scientific Software Installations (EESSI). [EESSI](https://eessi.github.io/docs/) is a collaboration between different HPC sites and industry partners, with the common goal to set up a shared repository of optimized scientific software installations that can be seamlessly used (and transparently updated) on a variety of computer systems, regardless of which flavor/version of Linux distribution or processor architecture is used, or whether it is a full-size HPC cluster, a cloud environment, a personal workstation, or even a Raspberry Pi. EESSI will support the scientific drivers of MultiXscale, enabling CI/CD best practices and distributing the software used and developed within the project across all EuroHPC systems (and beyond). EESSI uses a number of open source to provide its services: CernVM-FS for distribution, Gentoo Prefix for OS-compatibility, EasyBuild for scientific software installations, and Lmod for the user interface to the software stack. The successful applicant will take a leading role in maturing the EESSI infrastructure, and integrating its use in the MultiXscale project.
108

11-
[Netlify]: https://netlify.com
9+
!!! warning "Under Construction"
1210

13-
[mkdocs.yml]: https://github.com/Andre601/mkdocs-template/blob/master/mkdocs.yml
14-
[docs folder]: https://github.com/Andre601/mkdocs-template/blob/master/docs
15-
[workflow]: https://github.com/Andre601/mkdocs-template/blob/master/.github/workflows/deploy.yml
16-
17-
[LICENSE]: https://github.com/Andre601/mkdocs-template/blob/master/LICENSE
18-
19-
[gh-pages]: https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
20-
21-
# MkDocs Material Template
22-
This is a template repository for anyone that wants to use the MkDocs Material Theme.
23-
24-
## Getting Started
25-
To get started, first clone this template by clicking on the Green button labeled [`Use this template`][use].
26-
On the new screen, give your repository a name and make sure to check `Include all branches`. This will make sure that the `gh-pages` branch is included, or otherwhise publishing the docs to GitHub Pages could cause errors (See [Troubleshooting](#troubleshooting)).
27-
28-
> **Note**
29-
> GitHub changed how you define from where it takes the pages to build. You are now able to define both a branch and a specific folder from where GitHub would take the files to then deploy them on GitHub Pages.
30-
> You can read more about this [here][gh-pages].
31-
32-
### Creating pages
33-
To create new pages, just add new markdown files to the [docs folder] of the repository and edit them.
34-
MkDocs will then turn those into static HTML pages once you [build](#build-pages) or [deploy](#deploy-to-github) the pages.
35-
36-
The template also has some pre-made settings for your convenience to help you with creating documentation much easier.
37-
In the [mkdocs.yml] will you find many settings that you can alter. Please check the comments and the links they have for more info.
38-
39-
It also contains some extensions that might be useful including:
40-
41-
- Admonition
42-
- CodeHilite
43-
- ToC
44-
- [PyMdown Extensions]
45-
46-
You're free to add, edit or remove any extension at your own discretion, but keep in mind that some expansions might cause compatibility issues with others or require to be downloaded first.
47-
For that, alter the `requirements.txt` if you also deploy pages using GitHub Actions or [Netlify](#netlify)
48-
49-
## Build Pages
50-
To build pages (locally) can you use the `mkdocs build` command in your prefered command prompt.
51-
Note that for the successful execution of this command you have to...
52-
53-
- ...be in the folder that contains the `mkdocs.yml`
54-
- ...have Python 3.7 installed
55-
- ...have MkDocs and all required dependencies such as Material for MkDocs installed.
56-
Note that Material for MkDocs automatically downloads MkDocs and also certain extensions such as the [PyMdown Extensions].
57-
58-
MkDocs would now build the HTML in the defined configuration folder for you to use.
59-
60-
## Deploy to GitHub
61-
If you want to publish the pages on GitHub Pages can you use the [premade workflow][workflow] for this.
62-
This workflow will setup Python, download Material for MkDocs and all its dependencies and deploy the pages to the `gh-pages` branch to then be viewable under `<username>.github.io/<repository>` (unless you defined a specific CNAME through a CNAME file in the [docs folder]).
63-
64-
Note that in order for this to work will you need to have a `gh-pages` branch already made.
65-
66-
## Netlify
67-
Netlify is an amazing service to build and deploy pages. This template comes with a `runtime.txt` which is used by Netlify to determine the Python version used (They use an old version of Python... Don't ask why).
68-
69-
For more information, please check out their website.
70-
71-
## Dependabot
72-
The repository contains a `dependabot.yml` file inside the `.github` folder which allows automatic updates through GitHub's Dependabot.
73-
It is configured to target both Python dependencies (inside the `requirements.txt`) and GitHub Actions dependencies, to make sure bot are updated accordingly.
74-
75-
Note that it is configured by default to add the `Type: Update (Dependency)` label and also the `Target: Python (pip)` label for Python and `Target: GitHub Actions` label for GitHub Actions Dependencies.
76-
Those labels don't exist by default so you have to either create them, or alter the ones in the dependabot.yml (You can also just remove the `labels` sections).
77-
78-
## Troubleshooting
79-
> **The deploy action gives me an error when deploying. What is the issue?**
80-
81-
There can be many issues but the most common ones are that you either don't have a `gh-pages` branch set or that the `requirements.txt` file is missing or its content is invalid.
82-
83-
> **Can I alter the overall style of the pages?**
84-
85-
Yes. Material for MkDocs supports Theme extensions, meaning you can override specific parts of a theme by providing the particular file in a folder and defining this folder as the `custom_dir` one in the [mkdocs.yml].
86-
This template ships with a `theme` folder that can be used for that and you can just uncomment the aforementioned line in the YAML file.
87-
88-
89-
## Credits
90-
A big thank you goes to the following people/groups:
91-
92-
- [MkDocs] for providing the software, to generate documentation.
93-
- [squidfunk] for the [MkDocs Material Theme].
94-
- [facelessuser] for the [PyMdown Extensions].
95-
96-
## License
97-
This template is served under the MIT license.
98-
Read the [LICENSE] file for more info.
11+
The full website for MultiXscale is currently **under construction**. This page will be entirely replaced soon.

0 commit comments

Comments
 (0)