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: upstream block ADR, take 2 #35421

Merged
merged 2 commits into from
Sep 16, 2024

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Sep 3, 2024

@kdmccormick
Copy link
Member Author

@ormsbee @bradenmacdonald This is an updated take on my first upstream_block ADR, plus what I learned from actually implementing it, plus a new approach for limited customizability of downstream blocks.

Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

Looking good!

docs/decisions/0020-upstream-downstream.rst Outdated Show resolved Hide resolved
docs/decisions/0020-upstream-downstream.rst Show resolved Hide resolved
docs/decisions/0020-upstream-downstream.rst Outdated Show resolved Hide resolved
"""
...

def sync_from_upstream(self, *, user: User, apply_updates: bool) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

same here, I think these should be moved elsewhere or at least marked as @final

Copy link
Member Author

Choose a reason for hiding this comment

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

Moved

Copy link
Contributor

@ormsbee ormsbee left a comment

Choose a reason for hiding this comment

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

A couple of minor comments. I think it's a really solid ADR overall. I'm not sure that we need some of the low-level code details as part of the ADR itself, but I think it's fine like this as well.

"""),
default=None, scope=Scope.settings, hidden=True, enforce_type=True,
)
downstream_customized = List(
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe Set instead of List here?

Copy link
Member Author

Choose a reason for hiding this comment

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

👍🏻

docs/decisions/0020-upstream-downstream.rst Outdated Show resolved Hide resolved
@kdmccormick kdmccormick force-pushed the kdmccormick/upstream2 branch 2 times, most recently from 5cb9ecb to 1dd016e Compare September 13, 2024 15:33
@kdmccormick
Copy link
Member Author

@bradenmacdonald @ormsbee This is ready for re-review.

@kdmccormick
Copy link
Member Author

@bradenmacdonald Did you want to make another pass before I merge?

Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

@kdmccormick Nice work!

@kdmccormick kdmccormick merged commit e669400 into openedx:master Sep 16, 2024
49 checks passed
@kdmccormick kdmccormick deleted the kdmccormick/upstream2 branch September 16, 2024 17:01
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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.

4 participants