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

Feature/tedefo 2944 business entities #185

Open
wants to merge 10 commits into
base: 1.11.x
Choose a base branch
from

Conversation

rouschr
Copy link
Contributor

@rouschr rouschr commented Jan 9, 2024

I created a new page about business entities.
It is probably too technical in some parts.

@rouschr rouschr self-assigned this Jan 9, 2024
Copy link
Contributor

@pdonohoe pdonohoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page states that fields.json contains an array named "businessEntities". I can't find such an array in the SDK 1.10.0-rc.2, so I can't check some of the information in this page. This page should not be published until the "businessEntities" section in the fields.json is also published in a version of the SDK.

The sentence beginning: "In some fields there are patterns like:" - Update to describe what these patterns are used for, i.e. to generate Schematron checks to ensure that the content of the Fields exactly match the pattern (Regular Expression). Also that some of these values are used in Change sections to identify the section(s) of notices which have changed.

The sentence: "Values like LOT are described in various places outside of the pattern. But some values like PROCEDURE only existed in the SDK. This gave us a hint that machine readable information was missing somewhere in the SDK." - this does not make sense. It says that information is in the SDK, but is also missing from the SDK.

The sentence: "To solve this we decided to add what we call "business entities" to the SDK." - It is not clear what issue needs to be solved, or what these values (e.g. "PROCEDURE") are used for.

Under "Legacy Data", it states that some information in fields.json is obsolete. It then provides an example JSON. But the data in the JSON was not ever in fields.json. So the wording here is confusing. Make it clear that the JSON example is from the new business entities section.

The sentence beginning "The process of detecting changes" - improve to make it clear what changes are being discussed. Does it mean changes between versions of the SDK, or changes to data in published notices?

Copy link
Contributor

@rousso rousso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will directly update the branch and the PR. I want to add the relevant content for the developer guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants