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

[Tagging] Automatically add system tags for Organization #90

Closed
pomegranited opened this issue Aug 9, 2023 · 2 comments
Closed

[Tagging] Automatically add system tags for Organization #90

pomegranited opened this issue Aug 9, 2023 · 2 comments

Comments

@pomegranited
Copy link

Story

"As a content author, I want the system to maintain automatic tags on my content so that I don't have to perform these tasks manually when creating/updating content."

Full description

Follow up to

Implement automatic tagging for the system taxonomies defined in the MVP. These tags should be created/updated automatically from the content itself, triggered by the create/update events for courses, blocks, libraries, and library blocks provided by #78

Completion criteria

  • PR against edx-platform which addresses the behavioral specifications below, and adds the requested management command to manually trigger tag creation.
  • (Optional) PR against openedx-learning for any logic to extend oel_tagging that may be useful outside of the "content" context.
  • Automated testing must cover common paths in behavioral specification.

Behavioral specifications

Organization system taxonomy:

  • When the user creates a new course, block, library, or library block:
    • a new ObjectTag for that object is created against the Organization Taxonomy.
      Use the content's {{usage_key.org}} to locate the matching Organization {{short_name}}, and ensure the ObjectTag is linked to that Organization so that changes to the Organization {{name}} will be reflected when fetching the object tag value.
  • When the user updates an existing course, block, library, or library block:
    • if the object already has a Organization ObjectTag, no change is made to that tag. (Organization {{name}}s may change, but once content is created in an org, it becomes part of the identifying usage key, and so cannot be changed.)
    • if the object does not have an Organization ObjectTag, one is created against the Organization Taxonomy, same logic as with new objects.
  • When the user deletes a course, block, library, or library block:
    • any existing Organization ObjectTags for this object are deleted.
  • When an operator runs the "update tags" management command with a given list of course, block, library, or library block IDs, a new Organization ObjectTag is created if one does not already exist.

Documentation updates & improvements criteria

  • Ensure that the management command and its options are fully documented.

Relevant repositories

@pomegranited
Copy link
Author

pomegranited commented Aug 9, 2023

Note: we may not need these tags at all, as the Organization can be pulled from the object_id usage key, and stored in the search index without the need for tags.

Either way, it's out of scope for MVP.

@bradenmacdonald
Copy link
Contributor

Marking this as closed for now ^
We can re-open if there is some need in the future.

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

No branches or pull requests

2 participants