-
Notifications
You must be signed in to change notification settings - Fork 29
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
Added/updated README files and CHANGELOG for SDK 2. #504
base: efx-2
Are you sure you want to change the base?
Conversation
|
||
The documentation for the SDK is available at <https://docs.ted.europa.eu/eforms/latest>. The source for this documentation is maintained in the [eforms-docs](https://github.com/OP-TED/eforms-docs) repository. | ||
:heavy_check_mark: **No other breaking changes** in the metadata provided have been introduced in SDK 2. With the exception of the updates necessary for EFX parsers, metadata driven applications built on top of SDK 1 should be able to use the metadata provided in SDK 2 without any other changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on the paragraph below ("Future pre-release versions might introduce further breaking changes."), this statement is only valid for SDK 2.0.0-alpha.1, so this phrase should mention that version, and not "SDK 2" in general.
|
||
### Testing and Feedback | ||
|
||
We encourage users to test the pre-release version of the eForms SDK and provide feedback to help us improve the final release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should mention how to provide feedback.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I created a ticket, this is a valid point in general and many projects have a few chapters about where to ask or discuss about the project as this helps a bit. I created this ticket and I am ready to do something if we can agree: https://citnet.tech.ec.europa.eu/CITnet/jira/browse/TEDEFO-2471
Documentation on how to use the metadata provided in this folder can be found at <https://docs.ted.europa.eu/eforms/latest/codelists>. | ||
|
||
## SDK 2: Backwards compatibility | ||
:heavy_check_mark: **No breaking changes** in the metadata provided in this folder have been introduced by SDK 2. Metadata driven applications built on top of SDK 1 should be able to use the metadata provided in this folder without any changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this just mentions "SDK 2", it could be understood as being also applicable (a promise) for SDK 2.0.0.
If it is not the case, it should be indicated more clearly.
Same comment for this phrase in the other README.md files.
Although I am not yet familiar with the content but the readme.md information seems thorough and there is a version for each significant folder. The details suggested by Bertrand are relevant/ important and should be included. The information on the readme.md files and the information on the TED Documentation site complement each other well.
|
I added/updated readme files for SDK 2. @bertrand-lorentz can review and merge this. It would be good if @NPJ-OP-LUX also had a look.