Create user FAQ / documentation

pulibrary / figgy

Valkyrie-based digital repository backend.

Other

35 stars 4 forks source link

Create user FAQ / documentation #1538

Closed hackartisan closed 10 months ago

hackartisan commented 6 years ago

"What hapens if I’m ingesting and you deploy?"

Also discussed with RBSC curators; check those notes for more examples of things to include in this documentation.

hackartisan commented 6 years ago

"If there is a corrupt tiff can you catch that?"

hackartisan commented 6 years ago

Same as #1575? Or two different pages?

escowles commented 6 years ago

Curators asked for a "cheat sheet" with info such as:

What is a "slug"?
- How to report bugs/problems?
- How does Figgy relate to other systems?
- How ARKs work, and how various URLs are related (e.g. ARK shoulder in DPUL URL)
- Terminology — what things are called

sdellis commented 6 years ago

These should ultimately be addressed in the interface rather than a FAQ or "cheat sheet" as they are really shortcomings of the UI. If FAQs are needed, terms should not be defined in an FAQ but rather in a Glossary.

escowles commented 6 years ago

@sdellis I think we have a grab-bag now, and different items will require different solutions:

Some of these items should be addressed in the UI (e.g., the slug field should describe how we use it, and probably have a live-updating link saying your collection URL will be https://dpul.princeton.edu/[slug])
Other items can definitely go in a glossary
Some items (e.g., "How do I report a problem?") probably need a user guide.

tpendragon commented 3 years ago

@kelea99 Should we close this? There's a training program and a bunch of documentation now, yeah?

kelea99 commented 3 years ago

there is documentation. I do not have everything from above, that apparently the curators asked for. I am so sorry! Do you have more information on "terminology" and what was meant by that?

KEL should address: How ARKs work, and how various URLs are related (e.g. ARK shoulder in DPUL URL)

tpendragon commented 3 years ago

I assume things like when we say "Record Page", "Source metadata identifier", "Ephemera Folder", "Scanned Resource", "MapSet" maybe?

kelea99 commented 3 years ago

ok. May we leave this open until i create that as well? I want to make sure we cover everything that was asked. Ill make sure we can close by weeks end

tpendragon commented 3 years ago

Sounds good.

kelea99 commented 3 years ago

@tpendragon i have started a rough glossary of terms and will include the above in it. i am not sure if there are other sources that already define some things. anyone is welcome to review, add to, comment...

tpendragon commented 2 years ago

Kim will create a link in Confluence. Close this ticket when that happens.

kelea99 commented 10 months ago

done! all in confluence Figgy main page faqs glossaries