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

Clarify the purpose of the "ID" under Additional Info in the HTML rendering #55

Closed
thomasheritage opened this issue Jun 27, 2016 · 2 comments
Assignees

Comments

@thomasheritage
Copy link
Contributor

This "ID" is a URL that is the "ID" of the Rules Framework Component. However, it should be made clear that the URL may not be resolvable and may not be publicly accessible -- it's principal purpose is to act as an ID for the Component. Even if it is resolvable, it will usually resolve to the "raw" back-end Rules Framework Component file which is probably not of interest to anyone except Specification authors. To be clear, it is never necessary to click on an "ID" link under "Additional Information" in an HTML rendering of an AMWA AS-11 Rules-based Specification -- all the information required to understand and implement such as Specification is included within the Specification GitHub repository and is publicly accessible.

The intention is that "approved" Components (in Proposed Specifications and above) will have AMWA URLs and be publicly accessible using their IDs.

@Matthew-Marks
Copy link
Contributor

Suggest at least making the URLs inactive.

@thomasheritage
Copy link
Contributor Author

Resolved by commits across all the AS-11 Specs today (changes have been made to how this information is presented)

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

No branches or pull requests

2 participants