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.

Sign up for GitHub

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

Jump to bottom

docs: setup with tutor #17

Merged
merged 5 commits into from
May 23, 2023
Merged

docs: setup with tutor #17

merged 5 commits into from
May 23, 2023

Conversation

navinkarkera
Copy link
Contributor

@navinkarkera navinkarkera commented Apr 24, 2023 •
edited
Loading

Description: Document describing setup with edx-platform, discovery and tutor.

JIRA: Private-ref BB-7334

Dependencies:

Merge deadline: List merge deadline (if any)

Reviewers:

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

@openedx-webhooks
Copy link

openedx-webhooks commented Apr 24, 2023 •
edited
Loading

Thanks for the pull request, @navinkarkera! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 24, 2023
@navinkarkera navinkarkera marked this pull request as draft April 24, 2023 07:32
@navinkarkera navinkarkera marked this pull request as ready for review May 22, 2023 06:14
bmtcril
bmtcril reviewed May 22, 2023
View reviewed changes
docs/tutor_installation.rst Outdated
.. code-block:: shell

# Run below command and delete any xblock from studio to see the event logs flow in the consumer.
tutor dev run discovery ./manage.py consume_events --signal org.openedx.content_authoring.xblock.deleted.v1 --topic xblock-deleted --group_id test_group --extra '{"consumer_name": "c1"}'
Copy link
Contributor

Choose a reason for hiding this comment

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

--signal isn't necessary anymore, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bmtcril Yes, removed it.

bmtcril
bmtcril approved these changes May 23, 2023
View reviewed changes
Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

I think this is a good enough start for now. I'll need to talk with Regis about how we want to productionalize it for docker compose and k8s deployment and update this or have the Tutor docs themselves updated for that.

@bmtcril bmtcril merged commit f71ff33 into openedx:main May 23, 2023
@openedx-webhooks
Copy link

@navinkarkera 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

navinkarkera pushed a commit to open-craft/event-bus-redis that referenced this pull request May 24, 2023
@bmtcril @navinkarkera
Merge pull request openedx#17 from open-craft/navin/tutor-docs
ba811b5 
docs: setup with tutor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmtcril bmtcril bmtcril approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@navinkarkera @openedx-webhooks @bmtcril