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

Documentation tasks - Field Notes - Parent Issue #22

Open
1 task
ssarrafan opened this issue Nov 7, 2024 · 8 comments · May be fixed by #125
Open
1 task

Documentation tasks - Field Notes - Parent Issue #22

ssarrafan opened this issue Nov 7, 2024 · 8 comments · May be fixed by #125
Assignees
@mslarae13
Labels
documentation Improvements or additions to documentation priority:high This is a high priority to a team member

Comments

@ssarrafan
Copy link
Contributor

ssarrafan commented Nov 7, 2024 •
edited by eecavanna
Loading

Add list of documentation that needs to be updated related to the Field Notes App

User-facing documentation

  • User documentation
    • This has not been produced yet.

Other documentation

  • Marketing blurbs for the App Store pages
    • These have not been produced yet.
    • 🚫 These will not be designed to be pulled into centralized documentation website, but (I assume) they will be pulled into any third-party things that indiscriminately aggregate marketing blurbs from app stores.
  • Developer documentation
    • This exists as a README.md file in the nmdc-field-notes repository.
    • 🚫 It was not designed to be pulled into any centralized documentation website.
  • The NMDC Field Notes Mobile App page on the NMDC website
    • 🚫 It was not designed to be pulled into any centralized documentation website.
@ssarrafan ssarrafan converted this from a draft issue Nov 7, 2024
@mslarae13 mslarae13 self-assigned this Nov 7, 2024
@ssarrafan
Copy link
Contributor Author

Adding this issue for the next sprint to try to meet Jan deadline. If you prefer to have it in a later sprint let me know.

@ssarrafan
Copy link
Contributor Author

@mslarae13 any update on this one? If you don't get to it this week can you move to the next sprint?

Thanks!

@ssarrafan
Copy link
Contributor Author

Moving to new sprint. @mslarae13 let me know if I can help with this one.

@ssarrafan
Copy link
Contributor Author

Discussed this with @mslarae13 today and we may just use this documentation for Field Notes for now. This will be discussed at the Field Notes meeting on Monday 1/6.
FYI @pkalita-lbl @eecavanna

@mslarae13 mslarae13 moved this from Todo to In Progress in Documentation Squad Board Jan 3, 2025
@mslarae13 mslarae13 linked a pull request Jan 3, 2025 that will close this issue
Add documentation about the NMDC Field Notes app #125
Open
@mslarae13
Copy link
Contributor

@ssarrafan
what does "🚫 It was not designed to be pulled into any centralized documentation website." mean?

@mslarae13
Copy link
Contributor

We have "Submitting to NMDC" https://docs.microbiomedata.org/howto_guides/submit2nmdc.html which talks about the submission portal

I think it makes sense to add a field notes section here.

@ssarrafan
Copy link
Contributor Author

@ssarrafan what does "🚫 It was not designed to be pulled into any centralized documentation website." mean?

I didn't add that. I thought it was you but maybe it's from @eecavanna?

@ssarrafan ssarrafan added documentation Improvements or additions to documentation priority:high This is a high priority to a team member labels Jan 9, 2025
@ssarrafan
Copy link
Contributor Author

Discussed at docs squad meeting today. No concerns with updating FN docs by 1/17/25.
Videos and other updates will happen after the next big FNA release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mslarae13 mslarae13

Labels
documentation Improvements or additions to documentation priority:high This is a high priority to a team member
Projects
2024 > 2025 - Sprint 53 - December 30, 2024 - January 10, 2025
Status: In Progress
Documentation Squad Board
Status: In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation about the NMDC Field Notes app microbiomedata/docs
2 participants
@mslarae13 @ssarrafan