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

Finalize content for in-app tutorial #63

Closed
eecavanna opened this issue Mar 20, 2024 · 4 comments
Closed

Finalize content for in-app tutorial #63

eecavanna opened this issue Mar 20, 2024 · 4 comments
Assignees
Labels
beta-release Features and bug fixes that must be included in the first beta release documentation Improvements or additions to documentation

Comments

@eecavanna
Copy link
Collaborator

This ticket represents the task of finalizing the tutorial content (e.g. standardizing punctuation, addressing typos—if any).

The content is currently defined in the src/components/Tutorial/md-in-js folder.

For example, the bullet points in the first section are defined here (in Markdown format, within JavaScript files):

- Way of measuring sampling depth e.g., ruler, measurement device
- Sample storage method (e.g., preservative, cooler, freezer)
- Way of labeling samples (e.g., labeled tubes, sharpies, barcodes); can also bring barcode reader to log sample numbers from barcodes in the app
- Sample collection device (link the things from sample collection device field)
- Thermometer, or way of measuring air temperature and sample temperature
- Way of measuring elevation (e.g.,
- Way of locating sampling point (latitude and longitude)
- Slope aspect?
- Way of collecting pH (e.g., pH strips)

And the bullet points in the second section are defined here:

- Bring sunscreen, hat, sunglasses, bug spray
- Tell at least one person where you are going, when you are going, other information about your sampling trip
- Know local animals and dangers they may pose
- Check weather conditions and know risks for local weather events (e.g., flash floods)
- Know risks for injuries in the sampling environment
- Bring plenty of food and water
- Bring communication device(s), know limitations of them (e.g., no cell phone service)
- Proper shoes and clothes for the environment and weather
- Always better to sample with a group or another individual, try to never go alone
- Pack layers of clothing

A live version of the preliminary tutorial screen (implemented via PR #62) is at: https://fieldnotes.microbiomedata.org/tutorial

This issue is a follow-on to #48, which was about designing and implementing the screen.

@eecavanna eecavanna added documentation Improvements or additions to documentation ECR2024 labels Mar 20, 2024
@eecavanna
Copy link
Collaborator Author

Here's an example of a bullet point I think is incomplete:

@eecavanna
Copy link
Collaborator Author

Here's an example of two different punctuation styles being used:

- Way of measuring sampling depth e.g., ruler, measurement device
- Sample storage method (e.g., preservative, cooler, freezer)

The top one uses parentheses and the bottom one doesn't.

@eecavanna eecavanna changed the title Finalize tutorial content Finalize content for in-app tutorial Apr 15, 2024
@pkalita-lbl pkalita-lbl added beta-release Features and bug fixes that must be included in the first beta release and removed ECR2024 labels Apr 15, 2024
@eecavanna
Copy link
Collaborator Author

I think this is in progress (finalizing it based upon the current app functionality, that is).

@pkalita-lbl
Copy link
Collaborator

pkalita-lbl commented Jul 22, 2024

Content to add is documented here: https://docs.google.com/document/d/1oe3UzjaoGrHutzn6f-UMhZ1_83SY87FmiM3sa38rgG0/edit

Discussed in July 22 squad meeting and decided that what's currently in that document is good enough to move forward and we'll close this issue now.

@github-project-automation github-project-automation bot moved this from In Progress to Done in Field Notes Squad Board Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beta-release Features and bug fixes that must be included in the first beta release documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

5 participants