search

Plant-Tracer / webapp

Client and Server for web-based JavaScript app
GNU Affero General Public License v3.0
0 stars 2 forks source link

User Tutorial #543

Open sbarber2 opened 1 month ago

sbarber2 commented 1 month ago

We really need tutorial documentation about how to use the webapp

sbarber2 commented 1 month ago

Remember that @JoAnnJuzefyk has already drafted some.

JoAnnJuzefyk commented 1 month ago

This is the document: https://docs.google.com/document/d/1dQDroBjnQNUar3D5VwUsvxz1jAkao3JoRFfGZMj2jxU/edit?usp=drivesdk

It needs to be rewritten. Images are not same anymore. Some directions need editing. I will get started. Is there anything not there that I need to add? Any input would be appreciated. I don't recall getting any feedback. Do you want me to change format or layout?

J

On Thu, Oct 10, 2024, 10:45 AM Steve Barber @.***> wrote:

Remember that @JoAnnJuzefyk https://github.com/JoAnnJuzefyk has already drafted some.

  • Find it
  • update it
  • publish it

— Reply to this email directly, view it on GitHub https://github.com/Plant-Tracer/webapp/issues/543#issuecomment-2405313318, or unsubscribe https://github.com/notifications/unsubscribe-auth/A2A7GBO76LS2NQU2IBQXCVTZ22HIFAVCNFSM6AAAAABPW6YQD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBVGMYTGMZRHA . You are receiving this because you were mentioned.Message ID: @.***>

sbarber2 commented 1 month ago

I don't think I gave you feedback directly but I did edit the document as I reviewed it.

Go ahead and update what's there to reflect what's at the HEAD of main at the moment.

Then I think the fastest path to publication would be just to create a docs/UserTutorial.rst file and convert what you've got to ReStructured Text markup, putting the images in the docs/media folder.

ReStructured Text markup is easy-peasy, just look at the other .rst files in the docs folder for examples, and also https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html for the reference docs for the version of RST we are using.

Then once that is done, we can put a link to the tutorial in the webapp.

(Longer term, the dream is that we publish the docs to www.planttracer.com with a lovely CSS, but making www.planttracer.com maintainable is something we're still deferring until someone is excited to take that project on.)

On Thu, Oct 10, 2024 at 11:15 AM JoAnn Juzefyk @.***> wrote:

This is the document:

https://docs.google.com/document/d/1dQDroBjnQNUar3D5VwUsvxz1jAkao3JoRFfGZMj2jxU/edit?usp=drivesdk

It needs to be rewritten. Images are not same anymore. Some directions need editing. I will get started. Is there anything not there that I need to add? Any input would be appreciated. I don't recall getting any feedback. Do you want me to change format or layout?

J

On Thu, Oct 10, 2024, 10:45 AM Steve Barber @.***> wrote:

Remember that @JoAnnJuzefyk https://github.com/JoAnnJuzefyk has already drafted some.

  • Find it
  • update it
  • publish it

— Reply to this email directly, view it on GitHub < https://github.com/Plant-Tracer/webapp/issues/543#issuecomment-2405313318>,

or unsubscribe < https://github.com/notifications/unsubscribe-auth/A2A7GBO76LS2NQU2IBQXCVTZ22HIFAVCNFSM6AAAAABPW6YQD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBVGMYTGMZRHA>

. You are receiving this because you were mentioned.Message ID: @.***>

— Reply to this email directly, view it on GitHub https://github.com/Plant-Tracer/webapp/issues/543#issuecomment-2405407924, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFQOB3ZLKAKWNZCJNT6CJDZ22KZZAVCNFSM6AAAAABPW6YQD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBVGQYDOOJSGQ . You are receiving this because you authored the thread.Message ID: @.***>

sbarber2 commented 1 month ago

Is there anything not there that I need to add?

Also, the scope of the tutorial in that Google Doc leaves out quite a bit of current webapp functionality that'd we want to cover in a more complete user tutorial, but I think the best path is to update, reformat, and publish what you've already got, and then think about adding more stuff after that.

Just as a quick list of what we would add:

Note that I've intentionally excluded information here about demo mode and course admin capabilities; I think those are separate Issues/Tutorials.

Message ID: @.***>

sbarber2 commented 1 month ago

Edited proposed name of Tutorial.rst to be UserTutorial.rst

Part of this task is to add the new page to docs/index.html, too.

simsong commented 1 month ago

I recommend moving the tutorial out of Google Docs and doing it entirely on the website with restructured text.

On Oct 10, 2024, at 1:11 PM, Steve Barber @.***> wrote:

Is there anything not there that I need to add?

Also, the scope of the tutorial in that Google Doc leaves out quite a bit of current webapp functionality that'd we want to cover in a more complete user tutorial, but I think the best path is to update, reformat, and publish what you've already got, and then think about adding more stuff after that.

Just as a quick list of what we would add:

  • Movies list page, including play, unpublish, delete, undelete (and a quick description of publish), editing User Info
  • Analyze: graphs
  • Analyze: download trackpoints
  • Analyze: more detailed re-tracking example, especially after a tracking failure
  • Resend
  • Logout (and any issues about cookies)

Note that I've intentionally excluded information here about demo mode and course admin capabilities; I think those are separate Issues/Tutorials.

Message ID: @.***>

— Reply to this email directly, view it on GitHub https://github.com/Plant-Tracer/webapp/issues/543#issuecomment-2405643453, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAMFHLDWYYPE56IMKFFBR53Z22YLLAVCNFSM6AAAAABPW6YQD2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBVGY2DGNBVGM. You are receiving this because you are subscribed to this thread.

sbarber2 commented 1 month ago

That is indeed the plan.

On Thu, Oct 10, 2024 at 2:55 PM Simson L. Garfinkel < @.***> wrote:

I recommend moving the tutorial out of Google Docs and doing it entirely on the website with restructured text.

Message ID: @.***>

sbarber2 commented 4 weeks ago

Also: