docs: OT-2 instruction manual revisions #19620
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Delete if the project shouldn't go forward.
Created sections to see what this could look like. - placeholder section headers - placeholder text
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## edge #19620 +/- ##
==========================================
+ Coverage 23.04% 24.67% +1.62%
==========================================
Files 3437 3445 +8
Lines 302623 304722 +2099
Branches 39867 40009 +142
==========================================
+ Hits 69746 75188 +5442
+ Misses 232854 229509 -3345
- Partials 23 25 +2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
After this, we'll stop and make a branch from the draft pr. Each chapter will be a branch.
After this, these will be separate PRs.
Moving on to other chapters
ecormany
added
the
DO NOT MERGE
Collaborator
emilyburghardt
left a comment
emilyburghardt
left a comment
There was a problem hiding this comment.
Looking pretty good so far, Joe! Left a few comments that might be in sections you haven't gotten to yet (apologies if so). Re-request review whenever more files are ready/the whole thing is ready and I'll look again.
I will say the sandbox isn't working for me (pulls up the docs site, but it doesn't include the OT-2 manual). Not sure if this is a known issue.
Need to remove a file from the nav section of the .yml file and remove link from text in an obsolete file.
Found renders. Links in the JIRA ticket.
# Overview This PR updates and revises the backmatter sections for the OT-2 manual. It should clearly cover topics similar to the Flex manual. Sandbox: https://sandbox.docs.opentrons.com/docs-ot2-revisions-backmatter/ RTC-864 ## Changelog 3 new files replace OT-2 ch. 11, Appendix. You only have to review these: - `support.md` - `open-source.md` - `additional-docs.md` This also significantly changes the current OT-T end chapter. That version is an assorted grab-bag of info about Github, our warranty, unrelated stuff about liquid handling, and just alot of "no, I can't even..." sort of stuff. While not a verbatim duplicate of the Flex manual, it is very similar. Removed some Flex-specific things that aren't relevant to the OT-2. Still, very boilerplate-ish. ## Review requests Anything from the current OT-2 manual that's missing and should be in here? We're going in with a heavy hand. ## Risk assessment Low, docs; moderate because of the large, installed OT-2 base. --------- Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>
# Overview This migrates the OT-2 setup instructions into MkDocs. Accidentally includes box contents section (`box-contents.md`). Didn't mean to, but here we are. Sandbox should be: https://sandbox.docs.opentrons.com/docs-ot2-install-relocate/ ## Test Plan and Hands on Testing Please review for clarity and accuracy. ## Changelog This adds 3 new files (sorry, things get going and I forget to keep files separate) - requirements.md: the things you need to have/do before setting up OT-2 - unboxing.md: instructions and images in an ordered list - box-contents.md: to handle some other text that's been moved out of the installation section. Original images are untouched. Many have large padded margins, which puts almost too much whitespace around them. However, this is good enough for an old manual. Not sure it's worth it to remove this padding. They are clear and visible. ## Review requests Text, grammar, code? ## Risk assessment Medium. --------- Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>
# Overview This adds a System Description section to the revised OT-2 manual. This section should contain 3 files: - components - pipettes - robot specs Sandbox: https://sandbox.docs.opentrons.com/docs-ot2-system-description-revisions/ot-2/system-description/ RTC-859 ## Test Plan and Hands on Testing Have the usual suspects evaluate the content. ## Changelog When ready, should be 3 files in a System Description section. ## Review requests Does the text make sense? Does the organization make sense? Are the images clear and relevant? ## Risk assessment Low - moderate due to complexity of changes. --------- Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>
# Overview Revises and adds content to a "cleaning and maintenance" section for the OT-2 manual project. The cleaning and service sections will closely follow the Flex manual. Adding a new 'Self-Service' section to the manual to document some user-level board maintenance procedures. Note that this section is _optional_ and can be removed. For the scope of this ticket/task, adding further end-user repair procedures is out of scope; any additional self-repair tasks should be addressed in new, separate child tickets. Pictures and illustrations: - Images are a mixed bag. Generally potato quality and copies of the original OT-2 manual. Limited access to a robot means we have less to work with than with a Flex. - Using **red to highlight** because Opentrons blue doesn't contrast enough with dark PCBAs. - Requesting some new illustrations from Jackson. Marked by placeholder content. Sandbox: [Maintenance section](https://sandbox.docs.opentrons.com/docs-ot2-revisions-cleaning-and-maintenance/ot-2/maintenance/) RTC-863 ## Test Plan and Hands on Testing Try not to break anything. ## Changelog New files in a Maintenance chapter: - `cleaning.md` cleaning instructions based on the Flex manual. - `index.md` Intro/landing page - `self-service.md` Some user-level procedures. - `service.md` Services offered by Opentrons, based on Flex manual. ## Review requests - Make sure the text and instructions are clear, links work, and images make sense. - Should we save user-level, self-service for a 2nd version? ## Risk assessment Low, docs changes only. --------- Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Revise and migrate OT-2 instruction manual into the new documentation system. Flex instruction manual is the model.
Other changes: There should be no really new information added, unless something important is missing. This is old wine, a new bottle, and remove the sediment.
We will create separate branches from this for each chapter and merge those back into this branch after review.
Sandbox: https://sandbox.docs.opentrons.com/docs-ot2-manual-revisions/
References:
Test Plan and Hands on Testing
I can haz wordz. Plz read.
Changelog
2 new files for review:
introduction.mdregulatory.mdReview requests
If some text is familiar or seems familiar, that's because it may be. Some OT-2 sections are similar to the Flex manual. In many cases, this project will replace that older content with text from the Flex manual, and just change "Flex" to "OT-2."
Risk assessment
Low because this is documentation; medium because it is content an installed user-base relies on. Need to keep the revised manual useful for those folks.