Skip to content

Commit 8d58277

Browse files
mdonadonimdonadoni
committed
refactor(docs): move from reST to Markdown (#391)
Convert docs from reStructuredText to Markdown so that the changelog file is compatible with Release Please.
1 parent e938f60 commit 8d58277

11 files changed

+252
-284
lines changed

‎AUTHORS.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Authors
2+
3+
The list of contributors in alphabetical order:
4+
5+
- [Audrius Mecionis](https://orcid.org/0000-0002-3759-1663)
6+
- [Diego Rodriguez](https://orcid.org/0000-0003-0649-2002)
7+
- [Dinos Kousidis](https://orcid.org/0000-0002-4914-4289)
8+
- [Domenic Gosein](https://orcid.org/0000-0002-1546-0435)
9+
- [Giuseppe Steduto](https://orcid.org/0009-0002-1258-8553)
10+
- [Jan Okraska](https://orcid.org/0000-0002-1416-3244)
11+
- [Leticia Wanderley](https://orcid.org/0000-0003-4649-6630)
12+
- [Marco Donadoni](https://orcid.org/0000-0003-2922-5505)
13+
- [Marco Vidal](https://orcid.org/0000-0002-9363-4971)
14+
- [Sinclert Perez](https://www.linkedin.com/in/sinclert)
15+
- [Tibor Simko](https://orcid.org/0000-0001-7202-5803)

‎AUTHORS.rst

-16
This file was deleted.

‎CHANGELOG.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Changelog
2+
3+
## 0.9.3 (2023-12-12)
4+
5+
- Adds metadata labels to Dockerfile.
6+
- Changes version of NGINX Docker image from 1.19 to 1.25.
7+
8+
## 0.9.2 (2023-12-06)
9+
10+
- Adds automated multi-platform container image building for amd64 and arm64 architectures.
11+
- Adds option to delete all the runs of a workflow.
12+
- Adds form to generate the launcher URL of any user-provided analysis, together with the markdown snippet for the corresponding Launch-on-REANA badge.
13+
- Changes the Launch-on-REANA page to improve how workflow parameters are shown by displaying them inside a table.
14+
- Changes the Launch-on-REANA page to show improved validation warnings which also indicate where unexpected properties are located in the REANA specification file.
15+
- Changes version of Node.js Docker image from 16 to 18.
16+
- Fixes container image building on the arm64 architecture.
17+
18+
## 0.9.1 (2023-09-27)
19+
20+
- Adds support for previewing PDF files present in a workflow's workspace.
21+
- Adds support for previewing ROOT files present in a workflow's workspace.
22+
- Adds support for signing-in with a custom third-party Keycloak instance.
23+
- Adds a new menu item to the workflow actions popup to allow stopping running workflows.
24+
- Changes the workflow deletion message to clarify that attached interactive sessions are also closed when a workflow is deleted.
25+
- Changes the workflow progress bar to always display it as completed for finished workflows.
26+
- Changes the interactive session notification to also report that the session will be closed after a specified number of days of inactivity.
27+
- Changes the workflow-details page to make it possible to scroll through the list of workflow steps in the job logs section.
28+
- Changes the workflow-details page to not automatically refresh the selected job when viewing the related logs, but keeping the user-selected one active.
29+
- Changes the page titles to conform to the same sentence case style.
30+
- Changes workspace file preview to support customisable maximum file size limit allowed for previewing.
31+
- Changes nginx configuration to save bandwidth by serving gzip-compressed static files.
32+
- Changes the launcher page to show warnings when validating the REANA specification file of the workflow to be launched.
33+
- Changes the launcher page to allow showing custom demo examples.
34+
- Fixes calculation of workflow runtime durations for stopped workflows.
35+
36+
## 0.9.0 (2023-01-19)
37+
38+
- Adds Launch on REANA page allowing the submission of workflows via badge-clicking.
39+
- Adds notifications to inform users when critical levels of quota usage is reached.
40+
- Adds 404 Not Found error page.
41+
- Adds tab titles to all the pages.
42+
- Changes OAuth configuration to enable the new CERN SSO.
43+
- Changes the workflow-details page to show the logs of the workflow engine.
44+
- Changes the workflow-details page to show file sizes in a human-readable format.
45+
- Changes the workflow-details page to show the workspace's retention rules.
46+
- Changes the workflow-details page to show the duration of the workflow's jobs.
47+
- Changes the workflow-details page to display a label of the workflow launcher URL remote origin.
48+
- Changes the workflow-details page to periodically refresh the content of the page.
49+
- Changes the workflow-details page to refresh after the deletion of a workflow.
50+
- Changes the workflow-list page to add a way to hide deleted workflows.
51+
- Changes the workflow-list page to add new workflows sorting options by most used disk and cpu quota.
52+
- Changes the deletion of a workflow to always clean up the workspace.
53+
- Changes the announcements to support limited HTML markup.
54+
- Fixes redirection chain for non-signed-in CERN SSO users to access the desired target page after sign-in.
55+
- Fixes `fetchWorkflow` action to fetch a specific workflow instead of the entire user workflow list.
56+
- Fixes the ordering by size of the files showed in the `Workspace` tab of the workflow-details page.
57+
58+
## 0.8.2 (2022-02-15)
59+
60+
- Changes `node-sass` dependency to version 7.
61+
62+
## 0.8.1 (2022-02-02)
63+
64+
- Adds support for HTML preview of workspace files.
65+
- Adds search by name in workflow file list page.
66+
- Adds support for Create React App v5.
67+
- Changes cluster health status page to represent availability instead of usage.
68+
- Changes Docker image Node version from 12 to 16.
69+
70+
## 0.8.0 (2021-11-22)
71+
72+
- Adds user quota usage pie charts in Profile page.
73+
- Adds a more generic notifications system.
74+
- Adds a way to open, list and closes interactive sessions.
75+
- Adds the possibility of deleting workflows to save disk space.
76+
- Adds filtering by status and search by name in workflow list page.
77+
- Adds import aliases.
78+
- Adds cluster health status page.
79+
80+
## 0.7.2 (2021-02-04)
81+
82+
- Adds option to require user email confirmation after sign-up.
83+
- Adds option to display CERN Privacy Notice for CERN installations.
84+
- Changes notification system to improve sign-in and sign-up messages.
85+
86+
## 0.7.1 (2020-11-24)
87+
88+
- Fixes error handling behaviour for several server-side exceptions.
89+
90+
## 0.7.0 (2020-10-20)
91+
92+
- Adds user profile page.
93+
- Adds local user forms for sign-in and sign-up functionalities.
94+
- Adds home page suitable for standalone vs CERN deployments.
95+
- Adds page refresh button to workflow detailed page.
96+
- Adds favicon to the web interface pages.
97+
- Adds basic theme scaffolding.
98+
- Adds announcement configuration to easily display messages on the web interface.
99+
- Adds pagination on the workflow list and workflow detailed pages.
100+
- Fixes loading workflow indicator.
101+
- Fixes displaying of non-existing workflows.
102+
- Fixes file preview functionality experience to allow/disallow certain file formats.
103+
- Fixes workflow specification display to show runtime parameters.
104+
- Fixes display of footer links in case they are not set during deployment.
105+
- Changes configuration to dynamically detect URL.
106+
- Changes main loader of the web interface.
107+
- Changes workflow list page and all the code base to use hooks everywhere.
108+
- Changes pre-requisites to node version 12 and latest npm dependencies.
109+
- Changes polling to improve performance.
110+
- Changes default font to Open Sans.
111+
- Changes code formatting to respect updated `prettier` version coding style.
112+
- Changes documentation to single-page layout.
113+
114+
## 0.6.0 (2019-12-20)
115+
116+
- Basic login/user page using CERN SSO.
117+
- Simple user page showing user access token.
118+
- Adds GitLab projects integration.
119+
- Allows enabling/disabling GitLab project integration.
120+
- Improves UX in projects page.
121+
- Adds state management with Redux.
122+
- Includes SASS and CSS-modules support.
123+
- Loads config from server and store it in Redux state.
124+
125+
## 0.3.0 (2018-07-04)
126+
127+
- Initial public release.
128+

‎CHANGES.rst

-146
This file was deleted.

‎CONTRIBUTING.rst ‎CONTRIBUTING.md

+11-15
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
1-
Contributing
2-
============
1+
# Contributing
32

43
Bug reports, issues, feature requests, and other contributions are welcome. If you find
54
a demonstrable problem that is caused by the REANA code, please:
65

7-
1. Search for `already reported problems
8-
<https://github.com/reanahub/reana-ui/issues>`_.
6+
1. Search for [already reported problems](https://github.com/reanahub/reana-ui/issues).
97
2. Check if the issue has been fixed or is still reproducible on the
108
latest `master` branch.
119
3. Create an issue, ideally with **a test case**.
1210

1311
If you create a pull request fixing a bug or implementing a feature, you can run
1412
the tests to ensure that everything is operating correctly:
1513

16-
.. code-block:: console
17-
18-
$ ./run-tests.sh
14+
```console
15+
$ ./run-tests.sh
16+
```
1917

2018
Each pull request should preserve or increase code coverage.
2119

22-
2320
We are using Prettier to format our code. In order to use it before a pull request:
2421

2522
1. Install the package from NPM
2623

27-
.. code-block:: console
28-
29-
$ npm install prettier
30-
24+
```console
25+
$ npm install prettier
26+
```
3127

3228
2. Style your code
3329

34-
.. code-block:: console
35-
36-
$ prettier --write **/*.js
30+
```console
31+
$ prettier --write **/*.js
32+
```

0 commit comments

Comments
 (0)