UniversalViewer
Document all configuration options
With the configuration editor being unavailable for the newer version this documentation would be extremely helpful!!!
I want to reinstate the config editor if possible as a generic json-editing web component using stencil.js
@mialondon I think we should discuss this on the next steering group call. We're going to need to make it part of the next community sprint, which needs organising.
It's on the 18th at 3pm. I think we can probably allow it just this once :-)
Our next community sprint is supposed to be about documenting config. However, I'm wondering if the priority should be getting the config editor reinstated...
How would one use the config editor, if it existed? I suspect I would prefer to have documentation than figure out how to spin up and use such a tool. I'd likely have to re-learn how it works each time I want to make a change.
Previously it used this npmjs.com/json-editor, but I think this is looking pretty unmaintained now... People seemed to find it quite intuitive though.
On Mon, 2 Dec 2019, 13:38 hackmastera, [email protected] wrote:
How would one use the config editor, if it existed? I suspect I would prefer to have documentation than figure out how to spin up and use such a tool. I'd likely have to re-learn how it works each time I want to make a change.
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/UniversalViewer/universalviewer/issues/565?email_source=notifications&email_token=AAKFY6KUN2HHT7FXTXMRJL3QWUFT7A5CNFSM4EWONGB2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFTQNEQ#issuecomment-560400018, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAKFY6J4ZUDGCLCU2LOAZZTQWUFT7ANCNFSM4EWONGBQ .
All issues will be triaged for further investigation or closure by the 28 September 2023. If your issue is still relevant and would like for it be investigated further please comment by 14 September 2023.
If there's documentation now, please link to it and close the issue - otherwise we still need documentation for configuration options!
Ideally documentation would be public and human-readable so that we can share it with internal stakeholders to help them specify which options they'd like configured in specific instances. As the UV/IIIF is embedded in more projects, helping people articulate more precisely what they want will save a lot of time all round.
This is related to our work on setting up Storybook as interactive documentation: https://github.com/UniversalViewer/universalviewer/pull/892#issuecomment-1342923698
However, this is currently blocked.
In old ticket #217, @edsilv proposed that we use "description" in json schema to provide inline help. Description is at the same level as type and properties for every object. Not sure if this idea is still applicable, but just capturing here for the record.
See also a question on #495 that should be addressed as part of documentation if possible.
I've pushed this to main. You need to run npm run docs to generate the contents of a /docs folder. This is available to view at localhost:8080/docs
Ideally it would also be available at https://docs.universalviewer.io. I've tried following the github docs to set this up, but there's something wrong with it. I'll leave it to a future community call to figure that out.