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

Add ceterms:PathwayComponent usage note #586

Closed
stuartasutton opened this issue Mar 16, 2019 · 3 comments

Comments

Projects
None yet
3 participants
@stuartasutton
Copy link
Contributor

commented Mar 16, 2019

@siuc-nate, we need to add a usage note to ceterms:PathwayComponent as follows:

PathwayComponent is a super-type that represents a family of more precise sub-types. In pathway descriptions, always use the sub-type of PathwayComponent appropriate to your circumstances, e.g., AssessmentComponent, CocurricularComponent, CompetencyComponent, CourseComponent, CredentialComponent, ExtracurricularComponent, JobComponent, and WorkExperienceComponent. Use BasicComponent for types of entities not covered by the current set of sub-types.

Ideally, this would be handled using a best practice on this class, but in the absence of full-fledged best practices, a usage note will do.

@siuc-nate

This comment has been minimized.

Copy link

commented Mar 18, 2019

Is it a good idea to list all of the existing subclasses? That will lead to needing to update that note any time we add or remove a class.

@stuartasutton

This comment has been minimized.

Copy link
Contributor Author

commented Mar 18, 2019

Yes, it's necessary...it's not likely that there will be any kind of rush to add additional subclasses. Until we have a systematic, easy way for developers to quickly look up best practices (see #584), we're going to need to do some "building in".

@jkitchensSIUC jkitchensSIUC added this to the March 15, 2019 milestone Mar 19, 2019

@siuc-nate siuc-nate self-assigned this Apr 9, 2019

@siuc-nate

This comment has been minimized.

Copy link

commented Apr 10, 2019

This change has been made in pending CTDL and noted in the history tracking.

@siuc-nate siuc-nate closed this Apr 10, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.