Data Editor release documentation & training

NCEAS / arctic-data-outreach

Outreach and engagement activities for the Arctic Data Center

Apache License 2.0

3 stars 4 forks source link

Data Editor release documentation & training #17

Closed vlraymond closed 2 years ago

vlraymond commented 6 years ago

Needs before release date of 05/14/18

[x] press release reviewed and approved by AB, MJ, CJ, LW
[x] Ensure that PR includes: summary of major changes and enhancements from dev team
[ ] user-facing documentation live on arcticdata.io including:
[x] helper text for editor (issue #22)
[ ] "submission" documentation for arcticdata.io (issue #24, #44, #40)
[ ] update "Q&A" page with FAQ (issue #7)
[ ] banner that says "try out the new "beta""
[ ] once it's been in the wild for some time, we can send out press release and notify people
[ ] screencasts | To be done after release has been in the wild for some time (perhaps move this item to a separate ticket)

vlraymond commented 6 years ago

from Chris: "I’m liking the idea of developing the documentation in .rst format in github and then using a readthedocs sphinx build to publish a versioned user guide (similar to what Dave is doing with the DataONE documentation)."

http://docutils.sourceforge.net/rst.html

laurenwalker commented 6 years ago

I also like BookDown, which we looked at in our meeting today. It seems more lightweight and user friendly than sphinx docs.

On Wed, Feb 7, 2018 at 1:36 PM, vlraymond notifications@github.com wrote:

from Chris: "I’m liking the idea of developing the documentation in .rst format in github and then using a readthedocs sphinx build to publish a versioned user guide (similar to what Dave is doing with the DataONE documentation)."

http://docutils.sourceforge.net/rst.html

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/NCEAS/arctic-data-outreach/issues/17#issuecomment-363866414, or mute the thread https://github.com/notifications/unsubscribe-auth/AGVeFnnUYEs6vBfLewGmaB4YpJAGD1JTks5tSe0UgaJpZM4Rtqum .

-- National Center for Ecological Analysis and Synthesis (NCEAS) University of California Santa Barbara (UCSB)

vlraymond commented 6 years ago

why this is cool
why it helps with data management
new editor is a large departure from our existing one.

VR look in site visit PPT looking at new and old features (created by Lauren)

draft PR

vlraymond commented 6 years ago

released in Beta and Test on 4/27. LW suggests:

one to two week beta testing period with data team,
then after that, pass to PIs

Q: how to pick PIs?

pick someone friendly and give them the heads up (from MJ)
just let everyone use it and see what happens (from LW)

vlraymond commented 6 years ago

VR reviewed and edited PR