-
Notifications
You must be signed in to change notification settings - Fork 338
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: Lilac release notes #1939
Conversation
Thanks for the pull request, @pdpinch! I've created OSPR-5766 to keep track of it in JIRA, where we prioritize reviews. 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:
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. |
This is an early draft of the release notes. At this time, I'm mostly interested in feedback on the tables of contents and high-level formatting. Regarding content, I would consider this the bare minimum. My plan is to include:
|
@pdpinch Thanks for taking the lead on this! I have asked @michellephilbrick to get product info together also as raw materials. |
Learner Experiences | ||
=================== | ||
|
||
Account MFE |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Can we define "MFE" somewhere near the beginning of this document? Some people may not know what it means, and google doesn't define it unless you add in other keywords like "frontend".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Even better: just say "micro-frontend" instead :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I spelled out Micro Frontend. @bradenmacdonald let me know if that's sufficient.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works for me - thanks!
@pdpinch Thanks for starting this. |
I've created a readthedocs project for this branch: https://draft-lilac-release-notes.readthedocs.io/en/latest/ |
Thanks @nedbat -- I think maybe the easiest way to do that is give you access to my fork so you can add the webhook? If you disagree, just let me know how to set up the webhook and I'll do it. |
All set: webhook is added. |
Co-authored-by: Ned Batchelder <[email protected]>
…ocumentation into pdpinch/lilac-release-notes
I added what I could extract from the edX Partner announcements, but I have questions. I'll tag some folks. |
@pdpinch The Product team has finished providing their updates to this doc: https://docs.google.com/document/d/1ZD8rCrBHO6rg-a08ZUEvW_iX-2m7HBiCK09Gr-Rg_uc/edit?userstoinvite=wkhalid%40edx.org&ts=60afb481&actionButton=1#heading=h.x7y6fix3ys2z Please let me know if you need anything additional at this time. |
Open-Response Assessments | ||
------------------------- | ||
- Learners can submit rich text responses | ||
- Grading status message | ||
- Allow viewing ORA steps after peer review | ||
- See the Authoring Experience section below for more ORA enhancements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@marcotuts can you confirm these ORA enhancements for learners are include in Lilac? The text is my interpretation of https://partners.edx.org/announcements/open-response-assessment-update which isn't available to the community.
- Added username details to ORA report download | ||
- Added problem name and location to ORA report download | ||
- Added ORA zipped file download for submission text + attached files | ||
- Open response assessment problems as a component category | ||
- Separate assessment steps & schedule authoring areas in Studio | ||
- See the Learner Experience section above for more ORA enhancements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@marcotuts same question, for instructors. Can you confirm these ORA enhancements are included in Lilac? Let me know if I need any copy editing.
Thanks @michellephilbrick. I think I've incorporated everything from the product team. Please ask them to take a look at https://draft-lilac-release-notes.readthedocs.io/en/latest/lilac.html to see the current draft. |
@pdpinch 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
* intro text * links * table of contents * basic info from confluence wiki, poorly formatted * more structure and start of MFE release notes * link to Checkout MFE API docs is more trouble than its worth * updated Learner MFE section to reflect changes in Lilac wiki * mention CourseTalk removal * add stub for toggle documentation * spell out Micro FrontEnd * Update en_us/open_edx_release_notes/source/lilac.rst Co-authored-by: Ned Batchelder <[email protected]> * fix 'Title underline too short' warnings * what do I know about PCI? * Proctortrack Onboarding Status Menu * brief note about LTI 1.3 and xblock-lti-consumer. Does this fit? * remove duplicate proctortrack section * add Course Complete Milestones description * new branding * ORA updates for learners and authors * xblock-lti-consumer == lti-consumer-xblock and it is installed by default) * add Special Exams Experience (was ProctorTrack) * 3-day Streak Milestone * add Course Upsell Messaging and Payment * more details for mobile updates * more special exam details * more ORA updates * add a studio feature * add warning about courseware_studentmodule index migration * remove broken link Co-authored-by: Ned Batchelder <[email protected]> (cherry picked from commit 5782962)
I've cherry-picked this onto Lilac. |
@pdpinch no further comments or feedback from the Product team on the draft! |
OSPR-5766
DRAFT of release notes for lilac open-release
fixes openedx/wg-build-test-release#61
fixes openedx/wg-build-test-release#15
Date Needed (optional)
5/9/2020
Reviewers
Possible roles follow. The PR submitter checks the boxes after each reviewer finishes and gives 👍.
FYI: @arbrandes @BbrSofiane @mkdavies @briangrossman
Testing
HTML Version (optional)
Post-review