Skip to content

Commit

Permalink
docs: LSDV-4803: Concatenate release notes based on specific release …
Browse files Browse the repository at this point in the history
…md files in docs (HumanSignal#3863)

* Concat onprem files

* Add collapse script

* Open on location hash

* open collapse with toc

* Split files

* remove script from release notes

* Remove release notes file

* Remove concat file

* Fix search

* Fixes

* Fixes 2

---------

Co-authored-by: makseq-ubnt <[email protected]>
  • Loading branch information
huguestennier and makseq authored Mar 18, 2023
1 parent 537e962 commit 432b36d
Show file tree
Hide file tree
Showing 15 changed files with 3,217 additions and 212 deletions.
2,419 changes: 2,349 additions & 70 deletions docs/package-lock.json

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"dependencies": {
"@sanity/client": "^3.4.1",
"co": "^4.6.0",
"concat-md": "^0.5.1",
"front-matter": "^4.0.2",
"hexo": "^6.3.0",
"hexo-admonition": "^1.1.2",
Expand Down Expand Up @@ -50,4 +51,4 @@
"devDependencies": {
"hexo-deployer-aws-s3": "^1.0.2"
}
}
}
37 changes: 37 additions & 0 deletions docs/scripts/release-notes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@

const fs = require('hexo-fs');
const concatMd = require('concat-md');

hexo.extend.filter.register('after_init', async function(){

const markdownFiles = await concatMd.default("source/guide/release_notes/onprem", { sorter: (a, b) => (a > b ? -1 : 1) });

const frontmatter = `---
NOTE: Don't user release_notes.md, it's automatically built from onprem/*.md files on hexo server run!
title: On-Premise Release Notes for Label Studio Enterprise
short: On-Premise Release Notes
type: guide
tier: enterprise
order: 221
order_enterprise: 142
section: "Reference"
meta_title: On-premise Release notes for Label Studio Enterprise
meta_description: Discover what's new and improved, and review bug fixes, in the release notes and changelog for Label Studio Enterprise.
---
!!! info
The release notes for Label Studio Community Edition is available on the <a href="https://github.com/heartexlabs/label-studio/releases"> Label Studio GitHub repository</a>.
!!! info
The release notes for Label Studio Enterprise Cloud (SaaS) is available <a href="https://heartex.com/changelog">here</a>.
`

const finalString = frontmatter + markdownFiles;

//writing to file
fs.writeFile("source/guide/release_notes.md", finalString, (err) => {
console.log(err);
});

});
147 changes: 15 additions & 132 deletions docs/source/guide/release_notes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
NOTE: Don't user release_notes.md, it's automatically build from onprem/*.md files!

title: On-Premise Release Notes for Label Studio Enterprise
short: On-Premise Release Notes
type: guide
Expand All @@ -12,12 +14,11 @@ meta_description: Discover what's new and improved, and review bug fixes, in the

!!! info
The release notes for Label Studio Community Edition is available on the <a href="https://github.com/heartexlabs/label-studio/releases"> Label Studio GitHub repository</a>.
<br>
<br>

!!! info
The release notes for Label Studio Enterprise Cloud (SaaS) is available <a href="https://heartex.com/changelog">here</a>.

<a name="243md"></a>

## New helm chart

Expand All @@ -29,11 +30,9 @@ The migration process can be performed without any downtime. The steps required

### Deprecation of the Old Chart

The old chart, heartex/label-studio-enterprise, **has been deprecated**. Support for as many releases as possible will be provided. A notification will be posted in the Release Notes section when this changes. We hope that this revised chart will meet your technical needs. If you have any questions or concerns, please don't hesitate to reach out to us.


The old chart `heartex/label-studio-enterprise` **has been deprecated**. Support for as many releases as possible will be provided. A notification will be posted in the Release Notes section when this changes. We hope that this revised chart will meet your technical needs. If you have any questions or concerns, please don't hesitate to reach out to us.

## Label Studio Enterprise 2.4.3

### Improvements
- Support simultaneous render of multi-channel audio with added splitchannels="true" option on Audio config (larger memory requirement) [LSDV-3028](https://labelstudio.aha.io/features/LSDV-3028)
- Allow selecting task automatically on Data Manager page whenever the user presses shift+up/down [LSDV-3093](https://labelstudio.aha.io/features/LSDV-3093)
Expand All @@ -59,10 +58,9 @@ The old chart, heartex/label-studio-enterprise, **has been deprecated**. Support
- Migration for fixing organization id in activity logs [LSDV-4629](https://labelstudio.aha.io/features/LSDV-4629)
- The first Audio V3 region created is not added to the undo stack [LSDV-1138](https://labelstudio.aha.io/features/LSDV-1138)


<a name="242md"></a>

## Label Studio Enterprise 2.4.2

### New Feature
- Labels are not displayed inside the regions [LSDV-1142](https://labelstudio.aha.io/features/LSDV-1142)
- Add YOLO support for PolygonLabels in export options [LSDV-2973](https://labelstudio.aha.io/features/LSDV-2973)
Expand Down Expand Up @@ -100,6 +98,7 @@ The old chart, heartex/label-studio-enterprise, **has been deprecated**. Support
- Saving model version on Machine Learning settings doesn't work [LSDV-966](https://labelstudio.aha.io/features/LSDV-966)


<a name="241md"></a>

## Label Studio Enterprise 2.4.1

Expand Down Expand Up @@ -133,6 +132,7 @@ The old chart, heartex/label-studio-enterprise, **has been deprecated**. Support
- Prevent annotation duplicates when 'Re-queue skipped tasks back to the annotator' parameter is selected [DEV-4228]
- Add Google project ID to Source/Target GCS form [DEV-4058]

<a name="240md"></a>

## Label Studio Enterprise 2.4.0
This section highlights the new features and enhancements, and bug fixes in Label Studio Enterprise 2.4.
Expand Down Expand Up @@ -212,6 +212,7 @@ This section highlights the new features and enhancements, and bug fixes in Labe
- Filtering failed to work for Annotation results [DEV-4060].
- Returned `400` bad requests on incorrect XML [DEV-3812].

<a name="231md"></a>

## Label Studio Enterprise 2.3.1
This section highlights the breaking changes, new features and enhancements, and bug fixes in Label Studio Enterprise 2.3.1.
Expand Down Expand Up @@ -464,6 +465,7 @@ Label Studio 2.3.1 includes the following bug fixes:
- Updated swagger docs for `AllStorage` APIs [DEV-2914].
- Added example output for `HyperTextLabels` in the Label Studio documentation suite [DEV-3632].

<a name="22md"></a>

## Label Studio Enterprise 2.2 Final

Expand Down Expand Up @@ -534,6 +536,7 @@ Label Studio 2.2.10 includes the following bug fixes:
- Fixed an issue when the Safari browser stopped working [DEV-2777].
- Fixed scrollable area in **Review** mode [DEV-2348].

<a name="229md"></a>

## Label Studio Enterprise 2.2.9

Expand Down Expand Up @@ -606,6 +609,7 @@ Label Studio 2.2.9 includes the following bug fixes:
- Fixed synchronization speed between video and audio [DEV-2207].
- Fixed an issue with prop `whenChoiceValue` [DEV-1833].

<a name="228md"></a>

## Label Studio Enterprise 2.2.8

Expand All @@ -615,8 +619,8 @@ This section highlights the breaking changes, new features and enhancements, and
Label Studio Enterprise 2.2.8 introduces the following new features and enhancements.

- This release displays comments in **DM** to reviewers [DEV-2598].
- Support for [Redis Secure Sockets Layer (SSL)](security.html#Secure-access-to-Redis-storage) [DEV-1768].
- Add tags and prefixes to [AWS metric parameters](custom_metric.html#How-to-write-your-custom-agreement-metric) [DEV-1917].
- Support for [Redis Secure Sockets Layer (SSL)](#Secure-access-to-Redis-storage) [DEV-1768].
- Add tags and prefixes to [AWS metric parameters](#How-to-write-your-custom-agreement-metric) [DEV-1917].
- Change review API to take into account feedback loop [DEV-2198].
- Notification Center [DEV-1658]
- Add drafts in Annotation History [DEV-2290].
Expand Down Expand Up @@ -676,125 +680,4 @@ Label Studio 2.2.8 includes the following bug fixes:
- Fixed the runtime error for users who deleted an annotation from **Quick View**, switched to another task, and returned back to the same task [DEV-2306].
- Added command for all orgs and optimize `update_tasks_counters` [DEV-2492].
- After annotations from predictions `is_labeled` should be recalculated [DEV-2490].
- Fixed 404 on skip [DEV-2416].



<script>
// Set the default state for sections on page load
const is_collapsed = true;

// Inject styles programmatically
const style = document.createElement("style");
style.textContent = `
.collapsible-content {
display: ${is_collapsed ? "none" : "block"};
}
.collapsible-header {
cursor: pointer;
position: relative;
}
.collapsible-header::before {
content: "${is_collapsed ? "" : ""}";
font-size: 70%;
position: absolute;
left: -1.25em;
opacity: 0;
transition: opacity 0.3s;
}
.collapsible-header:hover::before {
opacity: 1;
}
.collapsible-header.expanded::before {
content: "▼";
}
.toc button {
margin-top: 1.5em;
border-radius: 5px;
background: none;
border: 1px solid #aaa;
outline: none;
box-shadow: none;
cursor: pointer;
padding: 3px 10px;
}
.toc button:hover {
color: var(--color-yellow-120);
}
`;

document.head.appendChild(style);
function onDOMReady() {
const headers = document.querySelectorAll(".content-markdown h2");
headers.forEach((header) => {
header.classList.add("collapsible-header", is_collapsed ? "collapsed" : "expanded");
let content = header.nextElementSibling;
let nextHeader = getNextHeaderOrSibling(header);
while (content && content !== nextHeader) {
content.classList.add("collapsible-content");
content.style.display = is_collapsed ? "none" : "block";
content = content.nextElementSibling;
}
header.addEventListener("click", () => {
let sibling = header.nextElementSibling;
let nextSibling = getNextHeaderOrSibling(header);
while (sibling && sibling !== nextSibling) {
toggleCollapse(header, sibling);
sibling = sibling.nextElementSibling;
}
});
});
const collapseExpandBtn = document.createElement("button");
collapseExpandBtn.textContent = is_collapsed ? "Expand All": "Collapse All";
const toc = document.querySelector(".content-grid .toc");
toc.appendChild(collapseExpandBtn);
let allExpanded = !is_collapsed;
collapseExpandBtn.addEventListener("click", () => {
if (allExpanded) {
collapseExpandBtn.textContent = 'Expand All';
}
else {
collapseExpandBtn.textContent = 'Collapse All';
}
allExpanded = !allExpanded;
headers.forEach((header) => {
let sibling = header.nextElementSibling;
let nextSibling = getNextHeaderOrSibling(header);
while (sibling && sibling !== nextSibling) {
if (allExpanded) {
sibling.style.display = "block";
header.classList.remove("collapsed");
header.classList.add("expanded");
} else {
sibling.style.display = "none";
header.classList.remove("expanded");
header.classList.add("collapsed");
}
sibling = sibling.nextElementSibling;
}
});
});
}
function toggleCollapse(header, content) {
if (content.style.display === "none") {
content.style.display = "block";
header.classList.remove("collapsed");
header.classList.add("expanded");
} else {
content.style.display = "none";
header.classList.remove("expanded");
header.classList.add("collapsed");
}
}
function getNextHeaderOrSibling(element) {
while (element.nextElementSibling && element.nextElementSibling.tagName !== "H2") {
element = element.nextElementSibling;
}
return element.nextElementSibling;
}
if (document.readyState === "loading") {
document.addEventListener("DOMContentLoaded", onDOMReady);
} else {
onDOMReady();
}
</script>
- Fixed 404 on skip [DEV-2416].
74 changes: 74 additions & 0 deletions docs/source/guide/release_notes/onprem/2.2.8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
hide_sidebar: true
---

## Label Studio Enterprise 2.2.8

This section highlights the breaking changes, new features and enhancements, and bug fixes in Label Studio Enterprise 2.2.8.

### New features and enhancements
Label Studio Enterprise 2.2.8 introduces the following new features and enhancements.

- This release displays comments in **DM** to reviewers [DEV-2598].
- Support for [Redis Secure Sockets Layer (SSL)](security.html#Secure-access-to-Redis-storage) [DEV-1768].
- Add tags and prefixes to [AWS metric parameters](custom_metric.html#How-to-write-your-custom-agreement-metric) [DEV-1917].
- Change review API to take into account feedback loop [DEV-2198].
- Notification Center [DEV-1658]
- Add drafts in Annotation History [DEV-2290].
- Introduce new history types [DEV-2387].
- Support for System for Cross-domain Identity Management (SCIM 2.0) user and group provisioning [DEV-1823].
- Add the ability to pass a comment to APIs on skip [DEV-2458].

### Bugfixes
Label Studio 2.2.8 includes the following bug fixes:

- Per label score for Choices was calculated when no Choice was selected (hotfix-7) [DEV-2688].
- Fixed Rotating bounding box bugs (hotfix-4) [DEV-2647]
- Fixed permissions for manager role (hotfix-3) [DEV-2650]
- Fixed export to file using `SerializableGenerator` [DEV-2248].
- Fixed accepted state in review. [DEV-2256]
- Made Annotation History with linear Reject (Reject = Update + Reject) [DEV-2263].
- Fixed Annotation History icons [DEV-2264].
- Annotation history fixes [DEV-2265], [DEV-2268], [DEV-2271].
- Fixed an issue where the Annotation History was not loading because of string ID [DEV-2278].
- Fixed validation in Labeling Interface preview with Dynamic Labels [DEV-2249].
- Fixed history 404 on unskip in label stream [DEV-2262].
- Fixed **Annotation History** reset for predictions [DEV-2271].
- Fixed job cancellation for `_update_tasks_states` [DEV-2294].
- Fixed an issue to return `404` for `api/project/id/tasks` when the page was out of scope [DEV-2336]
- Interactive preannotations for **Paragraphs** [DEV-2253].
- Improved the speed to 180 secs for assigned tasks [DEV-2060].
- Disabled **Poly** and **Keypoints** for **Annotation History** [DEV-2283].
- Fixed tools multiplication issue [DEV-1690].
- Prevented the scroll-out **TopBar** option [DEV-2348].
- Fixed skip queue [DEV-2354].
- Allowed **Canvas** to fill all the space [DEV-930].
- Truncated long words in comments [DEV-2267].
- Added scroll to view when focus changes to `stickyList` in table component [DEV-1703].
- Used `contain` instead of `icontain` for **Annotation Result** field in the **Data manager** filters [DEV-2214].
- Fixed `is_labeled` for tasks with no assignments [DEV-1872].
- Added default settings [DEV-1577].
- Implemented `Go back to previously reviewed task` functionality for reviewing stream [DEV-1676].
- Refactored and optimized Redis Queues [DEV-2213].
- Fixed runtime error during import with no `total_annotations` and other [DEV-2374].
- Reviewed Next Task API performance optimizations [DEV-2350].
- Fixed the reset rejected status after the annotation update. [DEV-2216], [DEV-2321].
- Fixed skip **Annotation History** for the previous task in label stream [DEV-2407].
- Fixed Reviewed filter [DEV-1948].
- Fixed counters for skipped annotations [DEV-2406].
- Fixed an issue where tasks were flagged as REVIEWED by default [DEV-2438].
- Fixed an issue for skipped tasks to get the `Completed` status [DEV-2413].
- Fixed error when a user tried to delete all tasks [DEV-2456].
- Fixed filter by empty reviewers [DEV-2390].
- Fixed incorrect review card counters in the feedback loop for skipped annotations [DEV-2433].
- Moved from signal to model delete method [DEV-2410].
- Added new skip behavior for annotations that are requeued back to annotator [DEV-2617].
- Fixed **Annotation History** drafts [DEV-2290].
- Fixed regions for text span when it was out of bounding in the regions list and created horizontal scroll [DEV-2473].
- Fixed in **Manage Members** modal (on project **Members** tab, on workspace members, on **Members** settings) header with search overlaps by the main list [DEV-2473].
- Fixed `Textarea` for **Custom Function** on the **Quality** settings page [DEV-2473].
- Fixed `startOffset` for empty nodes [DEV-2480].
- Fixed the runtime error for users who deleted an annotation from **Quick View**, switched to another task, and returned back to the same task [DEV-2306].
- Added command for all orgs and optimize `update_tasks_counters` [DEV-2492].
- After annotations from predictions `is_labeled` should be recalculated [DEV-2490].
- Fixed 404 on skip [DEV-2416].
Loading

0 comments on commit 432b36d

Please sign in to comment.