<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
Galen,<br>
<br>
I was thinking along those same lines: give our users (library
staff) documentation references for each staff UI - making it
eas(ier) for folks to resolve questions they may have about the
Evergreen staff client. I think this would be a boon to the
Evergreen project as a whole and might* make users morph into DIG
members!<br>
<br>
This statement couldn't be more true: "Any project is only as good
as it's documentation."<br>
<br>
I believe you mentioned that Koha does this? Where there is a
"consortium" level document for any given interface, and it can be
overridden all the way down the org tree?<br>
<br>
So - I am for* the general idea. Exactly how* might require
everyone's input.<br>
<pre class="moz-signature" cols="72">-Blake-
Conducting Magic
Can consume data in any format
MOBIUS
</pre>
<div class="moz-cite-prefix">On 9/8/2020 11:27 AM, Galen Charlton
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CAPLnt67s2uDQRrXC2yjLJsDVD1WEjDuOJWPJii-vZfCV39fEVA@mail.gmail.com">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<div dir="ltr">
<div>Hi,</div>
<div><br>
</div>
<div>To propose an idea for discussion, the Antora work gives us
an opportunity for us to (re)consider shipping a pre-built
Antora site with each release of Evergreen. Pre-built
documentation could be made available via (say) <a
href="https://the.evergreen.server/docs/"
moz-do-not-send="true">https://the.evergreen.server/docs/</a>.</div>
<div><br>
</div>
<div>Some pros I see are:</div>
<div><br>
</div>
<div>* This would make it possible for the manual to be
completely self-contained.</div>
<div>* Being able to count on /docs/ being available could
inspire the creation of more context-sensitive help.</div>
<div>* /docs/ could more easily remain in sync with the version
of Evergreen that's currently installed.<br>
</div>
<div>* Sites that wish to customize their documentation but are
not writing it from scratch (or rewriting it wholesale) would
be able to do so. Admittedly, that was already possible, but
having more of the documentation site-building scripts in
Evergreen itself makes a difference.<br>
</div>
<div><br>
</div>
<div>Some cons include:</div>
<div><br>
</div>
<div>* This would add about 45M to the uncompressed size of the
Evergreen tarball. Not huge, but not nothing.</div>
<div>* Managing customized documentation that's built into an
Antora site would have a learning curve.</div>
<div>* Built-in documentation could make certain features that
consortium administrators have intentionally turned off a bit
more visible than may be desired.<br>
</div>
<div><br>
</div>
<div>If we do this, I imagine we'd need at least library
settings to control whether built-in documentation or
externally-managed documentation is linked to from the staff
interface. I could also imagine wanting to make access to
/docs/ controlled by a staff permission.<br>
</div>
<div><br>
</div>
<div>Thoughts? I should note that I'm _not_ proposing that we
try to do this for 3.6.0.<br>
</div>
<div><br>
</div>
<div>Regards,</div>
<div><br>
</div>
<div>Galen<br>
-- <br>
<div dir="ltr" class="gmail_signature"
data-smartmail="gmail_signature">
<div dir="ltr">
<div>Galen Charlton<br>
Implementation and Services Manager<br>
Equinox Open Library Initiative<br>
phone: 1-877-OPEN-ILS (673-6457)<br>
email: <a class="moz-txt-link-abbreviated" href="mailto:gmc@equinoxInitiative.org">gmc@equinoxInitiative.org</a><br>
web: <a href="https://equinoxInitiative.org"
target="_blank" moz-do-not-send="true">https://equinoxInitiative.org</a><br>
direct: +1 770-709-5581<br>
cell: +1 404-984-4366</div>
</div>
</div>
</div>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
Evergreen-dev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:Evergreen-dev@list.evergreen-ils.org">Evergreen-dev@list.evergreen-ils.org</a>
<a class="moz-txt-link-freetext" href="http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-dev">http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-dev</a>
</pre>
</blockquote>
<br>
</body>
</html>