From 3fe80b60322e3e69b6aa15ef52291f9febcb5a6b Mon Sep 17 00:00:00 2001 From: Ioannis Rousochatzakis Date: Thu, 27 Jul 2023 03:00:46 +0200 Subject: [PATCH] Updated the changelog and readme for version 2.0.0-alpha.1 --- CHANGELOG.md | 30 ++++++++++++++++++++++++------ README.md | 6 ++++++ 2 files changed, 30 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c8f1ed059..b5cc57a89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,29 @@ -# SDK 2.0.0 Release Notes +# eForms SDK 2.0.0-alpha.1 Release Notes -SDK 2.0.0 introduces a new, more expressive version of EFX (the eForms Expression Language) which allows us to improve the visualisation of eForms notices, as well as the expressiveness and readability of business rules. +SDK 2.0.0-alpha.1 is the first in a series of pre-releases of the upcoming eForms SDK 2.0.0. -Some of the changes introduced with eForms SDK 2, are not backwards compatible with earlier releases. Applications that use SDK 1.x,x, will need to be updated to use the new version of the SDK. +## Caution: Pre-release +Please be aware that **this is a pre-release version** intended to give you a chance to preview and follow the development of the next major version of the SDK. -A detailed list of changes as well as a complete migration guide are available in the [eForms SDK 2 "Welcome" document](https://docs.ted.europa.eu/home/eforms/sdk2/). +## Objective +The goal of SDK 2 is to introduce a new, more expressive version of EFX (the eForms Expression Language) which will us to improve the visualisation of eForms notices, as well as the expressiveness and readability of business rules. -The documentation for the SDK is available at . The source for this documentation is maintained in the [eforms-docs](https://github.com/OP-TED/eforms-docs) repository. +## Contents +In short, SDK 2.0.0-alpha.1 consists of a development version of EFX-2, and a development version of SDK 1.9.0. + +- SDK 2.0.0-alpha.1 is being released to provide access to the updated grammar of EFX-2. +- The remaining contents of SDK 2.0.0-alpha.1 are borrowed from the current development version of SDK 1.9.0. + +A detailed list of changes as well as a complete migration guide are being made available in the [eForms SDK 2 "Welcome" document](https://docs.ted.europa.eu/home/eforms/sdk2/). This documentation evolves as the development of SDK 2 progresses, and therefore it may not be fully updated at all times until the eventual release of SDK 2.0.0. + +A comprehensive list of changes between SDK 1.8.0 and SDK 2.0.0-alpha.1 can be seen at . + +## Backwards compatibility -A comprehensive list of changes between SDK 1.7.0 and SDK 2.0.0 can be seen at . \ No newline at end of file +Some of the changes introduced with eForms SDK 2, are not backwards compatible with earlier versions. Applications that use SDK 1.x,x, will need to be updated to use the new version of the SDK. More specifically SDK 2.0.0-alpha.1 introduces breaking changes in the EFX grammar. + +Further pre-release versions will follow. Future alpha versions my introduce further breaking changes. + +--- + +The documentation for the SDK is available at . The source for this documentation is maintained in the [eforms-docs](https://github.com/OP-TED/eforms-docs) repository. diff --git a/README.md b/README.md index 2840c9830..84d30a33b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ This project, managed by the Publications Office of the European Union, aims to facilitate the implementation of the European legislation for the publication of public procurement notices on the [TED website](https://ted.europa.eu). For more information on the legislation, see the [DG GROW eForms page](https://ec.europa.eu/growth/single-market/public-procurement/digital/eforms_en). +# SDK 2 PRE-RELEASE +**Caution:** This is a **pre-release** version of SDK 2 which is still under development. The purpose of this release is to allow the developer community to preview and follow the development of SDK 2 and provide feedback. Further pre-release versions will follow. + +For further info on this pre-release version see the [changelog](CHANGELOG.md). + +# Contents The eforms SDK provides the necessary resources for building eForms applications that create, edit, visualise, validate and submit for publication, valid eForms notices. It contains several different metadata assets, organised in folders as follows: - `codelists`: The controlled vocabularies (codelists) used in eForms notices, as [Genericode files](https://docs.oasis-open.org/codelist/genericode/doc/oasis-code-list-representation-genericode.html).