Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add release notes for v2.0 #25

Merged
merged 4 commits into from
Aug 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ name: build

on: [push, workflow_dispatch]

permissions:
contents: write
id-token: write

jobs:
build:
uses: datavisyn/github-workflows/.github/workflows/build-node.yml@main
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 36 additions & 4 deletions src/pages/NewsPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,43 @@ import { Link } from 'react-router-dom';
import confetti from 'canvas-confetti';

import { hasCookie } from 'coral';

import coralHero from '../assets/coral-hero.png';
import newSession from '../assets/news/new_session.png';
import exportCohorts from '../assets/news/export_cohorts.png';

import v120_newSession from '../assets/news/v120_new_session.png';
import v120_exportCohorts from '../assets/news/v120_export_cohorts.png';

import v200_plotsWithoutGridLines from '../assets/news/v200_plots-without-grid-lines.png';

/** *****************************************************************************************
* REMINDER: UPDATE THE TEASER ON THE HOME PAGE WHEN ADDING A NEW NEWS ITEM!
******************************************************************************************** */

const sections = [
{
id: 'v2-0',
name: 'Version 2.0',
date: '2023-08-11',
markup: () => (
<>
<p className="lead text-muted">
This update contains several <b>style changes</b>, <b>bugfixes</b>, and structural changes of the application. The most important changes are:
</p>
<h5 className="mt-4">Remove grid lines from visualizations</h5>
<p>The grid lines in the visualizations have been removed to improve the readability of the visualizations.</p>
<img className="img-fluid border border-gray-300" src={v200_plotsWithoutGridLines} alt="Plots without grid lines." />

<h5 className="mt-4">Fix colors assignment in plots</h5>
<p>
Previously, the color assignment for cohorts with the same name (e.g., after filtering two cohorts by <i>Gender: Female</i>) in plots was wrong. We
have fixed this issue and the correct color of the cohort should be assigned now.
</p>

<h5 className="mt-4">Select root cohort automatically after onboarding</h5>
<p>The onboarding is only displayed when users launch the application for the first time. Afterwards, the root cohort is selected automatically.</p>
</>
),
},
{
id: 'v1-2',
name: 'Version 1.2',
Expand All @@ -26,15 +58,15 @@ const sections = [
the export button will be displayed in the top right of the operation area. The exported data will match the displayed table.
</li>
</ul>
<img className="img-fluid border border-gray-300" src={exportCohorts} alt="Export cohorts" />
<img className="img-fluid border border-gray-300" src={v120_exportCohorts} alt="Export cohorts" />

<h5 className="mt-4">Start a New Session</h5>
<ul>
<li>
You can now start a new session by clicking the <b>Start New Session</b> button next to the available datasets.
</li>
</ul>
<img className="img-fluid border border-gray-300" src={newSession} alt="Start new session" />
<img className="img-fluid border border-gray-300" src={v120_newSession} alt="Start new session" />

<h5 className="mt-4">Briefly noted</h5>
<ul>
Expand Down
8 changes: 4 additions & 4 deletions src/pages/components/CoralTeaserCards.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ export function CoralTeaserCards() {
</h4>
<div className="card shadow-sm h-100">
<div className="card-body">
<p className="card-text">🎉 It&apos;s the 2-year anniversary of Coral and we&apos;re happy to launch Coral v1.0! 🚀</p>
<p className="card-text">
This websites introduces Coral&apos;s <Link to="/features">features</Link>, the <Link to="/datasets">available datasets</Link>, and{' '}
<Link to="/publications">publications</Link>. We also provide an <Link to="/help">introductory video</Link> to get to know Coral.
<b>Coral 2.0 is available! 🚀</b>
</p>
<p className="card-text">
The latest Coral release contains several <b>style changes</b>, <b>bugfixes</b>, and structural changes of the application.
</p>
<p className="card-text">In the upcoming releases, we will focus improving the usability and interactions with Coral.</p>
</div>
<div className="card-footer">
<Link to="/news" className="btn btn-light">
Expand Down
Loading