Thanks Jessamyn!

One thing that I think needs improvement is the division between the
openlibrary.org/developers page, the openlibrary.org/dev/... tree, and the
pages at http://code.openlibrary.org/en/latest/.

It used to be that some of the members of the ol-tech list had edit
privileges to the /dev/... tree, as you can see here
<https://openlibrary.org/dev?m=history> and here
<https://openlibrary.org/dev/docs/committing>, but those privileges were
apparently revoked (w/o notice) at some point and the /dev/... pages are
not linked to from anywhere, so all that information should probably be
transferred somewhere else, if it hasn't already been.

I'm not sure what the reason was for reversing course on allowing people to
help with the developer documentation maintenance, but, in my opinion, that
information should be on a wiki which is publicly editable.  Github
provides such as wiki as part of its standard offering.
https://github.com/internetarchive/openlibrary/wiki

The current update mechanisms are limited to either sending email (for
openlibrary.org) or creating a pull request (for code.openlibrary.org),
both of which are relatively high overhead processes.

Some of the pages which are currently hidden/unlinked include:

https://openlibrary.org/dev/docs/committing
https://openlibrary.org/dev/roadmap (obsolete except for links to current
and historical trackers on Github and Launchpad)
https://openlibrary.org/dev/people (needs a lot of updating)
https://openlibrary.org/dev/docs (a whole tree of info, some outdated,
which needs reviewing)

Tom




On Sun, Nov 29, 2015 at 10:32 AM, jessamyn c. west <[email protected]>
wrote:

> Long time coming but I added these to the main documentation page and
> moved some other stuff around a little. Please take a look and see
> what other links should be on this page.
>
> https://openlibrary.org/developers
>
> ________
> Jessamyn
>
> librarian.net ::: jessamyn.com ::: jessamyn.info ::: box 345, randolph vt
> 05060
>
>
> On Wed, Sep 9, 2015 at 3:22 PM, jessamyn c. west <[email protected]>
> wrote:
> > This is great. I will see if I can add links somewhere in the Dev
> section of OL.
> >
> > ________
> > Jessamyn
> >
> > librarian.net ::: jessamyn.com ::: jessamyn.info ::: box 345, randolph
> vt 05060
> >
> >
> > On Fri, Sep 4, 2015 at 12:16 AM, Charles Horn <[email protected]>
> wrote:
> >> Thanks Tom,
> >>
> >> I had found Anand's blog previously, which was helpful. The others are
> new
> >> to me, I'll check them out too.
> >>
> >> Cheers,
> >> Charles.
> >>
> >> On 4 September 2015 at 05:31, Tom Morris <[email protected]> wrote:
> >>>
> >>> I recently discovered that some of the OL developers have been keeping
> >>> blogs which contain lots of useful bits of info.  In particular, Gio's
> blog,
> >>> since he's brand new, contains documentation of lots of bits and
> pieces that
> >>> he found confusing or undocumented as he was learning the system, which
> >>> would probably be helpful to other new developers.
> >>>
> >>>     http://gio.blog.archive.org/category/openlibrary/
> >>>     http://anand.blog.archive.org/
> >>>     http://raj.blog.archive.org/tag/openlibrary/
> >>>
> >>> There's also a set of info on the wiki pages that we started to update
> a
> >>> couple of years ago which I think is no longer linked (or if it is,
> it's not
> >>> easily findable).
> >>>
> >>>     https://openlibrary.org/dev
> >>>
> >>> The current developer documentation is at:
> >>>
> >>>     http://code.openlibrary.org/en/latest/
> >>>
> >>> and is built from sources in the repo's openlibrary/doc directory.
> >>>
> >>> For completeness, the official OpenLibrary blog (which tends to be more
> >>> end user / feature focused) is at:
> >>>
> >>>     http://blog.openlibrary.org/ (aka
> http://openlibrary.blog.archive.org)
> >>>
> >>> Hope these links are useful to folks!
> >>>
> >>> Tom
> >>
> >>
> >>
> >> _______________________________________________
> >> Ol-tech mailing list
> >> [email protected]
> >> http://mail.archive.org/cgi-bin/mailman/listinfo/ol-tech
> >> Archives: http://www.mail-archive.com/[email protected]/
> >> To unsubscribe from this mailing list, send email to
> >> [email protected]
> _______________________________________________
> Ol-tech mailing list
> [email protected]
> http://mail.archive.org/cgi-bin/mailman/listinfo/ol-tech
> Archives: http://www.mail-archive.com/[email protected]/
> To unsubscribe from this mailing list, send email to
> [email protected]
>
_______________________________________________
Ol-tech mailing list
[email protected]
http://mail.archive.org/cgi-bin/mailman/listinfo/ol-tech
Archives: http://www.mail-archive.com/[email protected]/
To unsubscribe from this mailing list, send email to 
[email protected]

Reply via email to