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

docs: service layer adr #33812

Closed
wants to merge 2 commits into from
Closed

docs: service layer adr #33812

wants to merge 2 commits into from

Conversation

jesperhodge
Copy link
Member

No description provided.

are a public set of wrappers around existing functionality, and are not intended to
be used for production course authoring yet. The responsibility for avoiding conflicts
and resolving them if they occur is on the user.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would suggest the following minor change:

The objectives for public authoring APIs changed from the time this decision was made:
we are now limiting our offering to a set of experimental APIs with which to flesh our what a supported set of APIs might become. As such, the authoring APIs we are now implementing
are just a public set of wrappers around existing functionality, and are not fit for production course authoring. The responsibility for avoiding conflicts and resolving them, if they occur, is on the user.


Examples
--------

Copy link
Contributor

Choose a reason for hiding this comment

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

You should include a preamble in this examples section that addresses how the example satisfies the decision elements listed above. That is, you want to spell out how videos_provider.py satisfies the objectives for a service layer.

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.

2 participants