Skip to content

Commit a8cd542

Browse files
Soap2GgarciagenriqueCopilot
authored
feat: towards the VREx (#32)
* feat: adding latest news * fix: apply suggestions from code review and add all events * chore: indentation of proceedings and addition of related labels * fix: adding descriptions to all of the members * feat: adding new images Reference: #31 * chore: restructuring main page and adding WIP placeholders * feat: restructuring the homepage * chore: minor fixes Co-authored-by: Copilot <[email protected]> * chore: spelling --------- Co-authored-by: Enrique Garcia <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent ad9f8e4 commit a8cd542

File tree

14 files changed

+58
-62
lines changed

14 files changed

+58
-62
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
> 🚧 May 2025: Under construction
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
> 🚧 May 2025: Under construction

docs/tech-docs/home.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
# CERN VRE Technical Documentation
2-
3-
4-
Welcome to the CERN Virtual Research Environment (VRE) technical documentation!
51

62
<center>
73
<div class="vre-cern-docs">
84
<img src="/img/vre-cern-docs.png" />
95
</div>
106
</center>
117

8+
# CERN VRE Technical Documentation
9+
Welcome to the CERN Virtual Research Environment (VRE) technical documentation!
1210

13-
In these pages you will be able to find detailed documentation of how the VRE infrastrucutre is set up. Please make use of the lateral sidebar to navigate through the different sections.
11+
In these pages you will be able to find detailed documentation of how the VRE infrastructure is set up. Please make use of the lateral sidebar to navigate through the different sections.
1412

1513
If you are looking for the GitHub repository of VRE infrastructure visit this [page](https://github.com/vre-hub/vre). If you want to improve the content of this documentation and you are looking for the VRE documentation repository, click [here](https://github.com/vre-hub/vre-hub.github.io).
1614

docusaurus.config.js

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -89,30 +89,32 @@ const config = {
8989
to: '/team',
9090
label: 'About us',
9191
},
92-
93-
{
94-
type: 'doc', // This is a preset regarding the type of document, please update if needed
95-
docId: 'auth', // The ID of the corresponding document. This should match with what you wrote in the document header.
96-
position: 'left',
97-
label: 'AAI', // The title that will appear on the menu
98-
},
99-
{
100-
type: 'doc', // This is a preset regarding the type of document, please update if needed
101-
docId: 'rucio', // The ID of the corresponding document. This should match with what you wrote in the document header.
102-
position: 'left',
103-
label: 'Rucio', // The title that will appear on the menu
104-
},
105-
{
106-
type: 'doc', // This is a preset regarding the type of document, please update if needed
107-
docId: 'reana', // The ID of the corresponding document. This should match with what you wrote in the document header.
108-
position: 'left',
109-
label: 'REANA', // The title that will appear on the menu
110-
},
11192
{
112-
type: 'doc', // This is a preset regarding the type of document, please update if needed
113-
docId: 'notebook', // The ID of the corresponding document. This should match with what you wrote in the document header.
114-
position: 'left',
115-
label: 'JupyterHub', // The title that will appear on the menu
93+
type: 'dropdown',
94+
label: 'The VRE components', // The ID of the corresponding document. This should match with what you wrote in the document header.
95+
position: 'left',
96+
items: [
97+
{
98+
type: 'doc', // This is a preset regarding the type of document, please update if needed
99+
docId: 'auth', // The ID of the corresponding document. This should match with what you wrote in the document header.
100+
label: 'AAI', // The title that will appear on the menu
101+
},
102+
{
103+
type: 'doc', // This is a preset regarding the type of document, please update if needed
104+
docId: 'rucio', // The ID of the corresponding document. This should match with what you wrote in the document header.
105+
label: 'Rucio', // The title that will appear on the menu
106+
},
107+
{
108+
type: 'doc', // This is a preset regarding the type of document, please update if needed
109+
docId: 'reana', // The ID of the corresponding document. This should match with what you wrote in the document header.
110+
label: 'REANA', // The title that will appear on the menu
111+
},
112+
{
113+
type: 'doc', // This is a preset regarding the type of document, please update if needed
114+
docId: 'notebook', // The ID of the corresponding document. This should match with what you wrote in the document header.
115+
label: 'JupyterHub', // The title that will appear on the menu
116+
},
117+
],
116118
},
117119
// {
118120
// type: 'doc', // This is a preset regarding the type of document, please update if needed
@@ -146,7 +148,7 @@ const config = {
146148
type: 'doc',
147149
docId: 'tech-docs/home',
148150
position: 'left',
149-
label: 'Technical Documentation'
151+
label: 'Dev Documentation'
150152
}
151153
],
152154
},

src/pages/LatestNews.jsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const newsItems = [
2929
title: 'Data discovery, analysis and reproducibility in Virtual Research Environments ', // this is what I would see indented below its parent contribution. NOT IMPORTANT !
3030
authors: 'E. Garcia-Garcia, G. Guerrieri, et al.',
3131
links: [{ text: 'CHEP 2024 proceedings', url: 'https://arxiv.org/abs/2503.02483/' }],
32-
iconType: 'file',
32+
iconType: 'book-open',
3333
type: 'proceedings',
3434
},
3535
{
@@ -49,7 +49,7 @@ const newsItems = [
4949
authors: 'E. Gazzarrini, E. Garcia Garcia, D. Gosein, and X. Espinal',
5050
journal: 'EPJ Web of Conferences 295, 08023 (2024)',
5151
links: [{ text: 'CHEP 2023 proceedings', url: 'https://doi.org/10.1051/epjconf/202429508023/' }],
52-
iconType: 'file',
52+
iconType: 'book-open',
5353
type: 'proceedings',
5454
},
5555
{
@@ -74,7 +74,7 @@ const newsItems = [
7474
title: 'The Virtual Research Environment: towards a comprehensive analysis platform',
7575
authors: 'E. Gazzarrini, E. Garcia, D. Gosein, A. Vendrell Moya, A. Kounelis, and X. Espinal',
7676
links: [{ text: 'ACAT 2022 proceedings', url: 'https://indico.cern.ch/event/1106990/papers/4991200/files/12795-The_VRE___ACAT22_Proceedings.pdf' }],
77-
iconType: 'file',
77+
iconType: 'book-open',
7878
type: 'proceedings',
7979
},
8080
{

src/pages/index.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
import LatestNews from './LatestNews'
22

3-
**🟩 Experiencing issues? Check the [service uptime status page](https://vre-hub.github.io/status) 🟩**
3+
<center>
4+
<div class="vre-cern-docs">
5+
<img src="/img/logo-vre-repo.png" />
6+
</div>
7+
</center>
48

9+
# The Virtual Research Environment
510
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Fjhub%2Fjhub-release.yaml&query=%24.spec.chart.spec.version&label=JupyterHub%20release&color=%23e66a2d)
611
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Freana%2Freana-release.yaml&query=%24.spec.chart.spec.version&label=Reana%20release&color=%23fd3337)
712
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Frucio%2Frucio-servers.yaml&query=%24.spec.values.image.tag&label=Rucio%20release&color=%23474986)
813
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Frucio%2Frucio-servers.yaml&query=%24.spec.chart.spec.version&label=Rucio%20helm%20charts)
914

10-
# The Virtual Research Environment
11-
1215
Access the VRE platform at https://jhub-vre.cern.ch!
1316

1417
The Virtual Research Environment is an analysis platform developed at **CERN** serving the needs of scientific communities involved in European Projects.
@@ -17,37 +20,34 @@ The platform's development is aimed at demonstrating how sciences spanning from
1720

1821
The Virtual Research Environment’s main components are:
1922

20-
![image](../../static/img/vre-bubble.png)
2123

22-
1. A federated and reliable **Authentication and Authorization** layer
23-
2. A **federated distributed storage** solution (the ESCAPE Data Lake), providing functionalities for data injection and replication through a Data Management framework (Rucio)
24-
3. A **computing** cluster supplying the processing power to run full analyses with Reana, a re-analysis software
25-
4. An enhanced **notebook interface** with containerised environments to hide the infrastructure’s complexity from the user.
24+
1. **[AAI](/docs/auth)**: A federated and reliable **Authentication and Authorization** layer
25+
2. **[The Rucio Data Lake](/docs/rucio)**: A **federated distributed storage** solution (the ESCAPE Data Lake), providing functionalities for data injection and replication through a Data Management framework (Rucio)
26+
3. **[Reana](/docs/reana)**: A **computing** cluster supplying the processing power to run full analyses with Reana, a re-analysis software
27+
4. **[JupyterHub](/docs/notebook)**: An enhanced **notebook interface** with containerised environments to hide the infrastructure’s complexity from the user.
2628

2729
![image](../../static/img/VRE-diagram.png)
2830

2931
The deployment of the Virtual Research Environment is open-source and modular, in order to make it easily reproducible by partner institutions; it is publicly accessible and kept up to date by taking advantage of state of the art IT-infrastructure technologies.
3032

31-
The Science Projects which are using the VRE are described [here](https://escape2020.pages.in2p3.fr/virtual-environment/home/).
33+
## Contact
34+
To contact the CERN VRE team with questions, doubts, problems accessing the meetings Indico category or the monitoring dashboards, please join the **[Mattermost channel](https://mattermost.web.cern.ch/signup_user_complete/?id=zqaa9p5fqfd9bnnc64at4b5aye&md=link&sbr=su)**. <br/>
35+
For more formal requests, i.e. conferences, webinars and events presentations, please email us at *escape-cern-ops 'at' cern.ch*.
3236

33-
If you are a scientist or a new user curious to use the above resources, please refer to the following documentation:
34-
1. **[AAI](/docs/auth)**
35-
2. **[Rucio Data Lake](/docs/rucio)**
36-
3. **[Reana cluster](/docs/reana)**
37-
4. **[Notebook service](/docs/notebook)**
37+
## Join the community
3838

39-
## Developers
39+
#### The ESCAPE Science projects repository
40+
The Science Projects which are using the VRE are described [here](https://escape2020.pages.in2p3.fr/virtual-environment/home/).
4041

41-
If you want to deploy the VRE on your own infrastructure, or if you want to submit an issue to help us improve the platform, please follow the [developer documentation](https://vre-hub.github.io/docs/tech-docs/home#how-to-contribute).
42-
43-
## Contact
44-
To contact the CERN VRE team with questions, doubts, problems accessing the meetings Indico category or the monitoring dashboards, please join the **[Mattermost channel](https://mattermost.web.cern.ch/signup_user_complete/?id=zqaa9p5fqfd9bnnc64at4b5aye&md=link&sbr=su)**. For more formal requests, i.e. conferences, webinars and events presentations, please email us at *escape-cern-ops 'at' cern.ch*.
42+
#### The VRE coordination meeting
43+
We have a recurrent meeting open to all scientists/researchers/developers interested in the VRE or who are supporting scientific infrastructures.
4544

46-
## Join the community
47-
There are is a recurrent meetings open to all scientists/researchers/developers interested in the VRE.
45+
**What do we discuss:**
46+
- Latest news and updates on the VRE technical infrastructure and use cases
47+
- Engagement with European projects and funding possibilities
48+
- Design, support, and operation of VREs for communities involved in the ESCAPE Collaboration, and beyond!
4849

49-
- The **VRE working-group monthly meetings** are intended for developers and system administrators who are supporting scientific infrastructures. They constitute an informal space to stimulate discussion and keep all the members up to date with the latest news and hot topics on the development and deployment of tools and services within the broad field of scientific analysis platforms. Join [here](https://indico.cern.ch/category/17065/).
50+
See [our meetings agenda](https://indico.cern.ch/category/17065/).
5051

5152
## Latest News
5253
<LatestNews />
53-

src/pages/markdown-page.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

src/pages/team.jsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ const TeamPage = () => {
108108
<Layout title="Team" description="Meet the team behind the project.">
109109
<section className={styles.teamSection}>
110110
<div className={styles.container}>
111+
<img src={require('@site/static/img/vre-team.png').default} alt="VRE Team photo" />
111112
<h1 className={styles.title}>The ESCAPE VRE Team</h1>
112113
{teamMembers.map((person, idx) => (
113114
<div key={idx} className={styles.personCard}>

static/img/VRE-diagram.png

-501 KB
Loading

static/img/favicon.ico

264 KB
Binary file not shown.

0 commit comments

Comments
 (0)