kicad-developers team mailing list archive

[Adam Wolf <adamwolf@xxxxxxxxxxxxxxxxxxxx>]

This sounds awesome to me, and helps keep KiCad cohesive.  I remember
when basically every KiCad site was a fan site and it was pretty hard
to find anything, and we have done a great job lately and this is
going to help make it even better I think!

I do not think that this even technically requires to change the
static site engine, if you already have a lot of work or a reason to
stick with whatever you have already used.  It is pretty easy for the
site folks to host the static site out of a different directory, for
example.  (It's a bummer when you show something cool to a mailing
list and everyone is enthusiastic but then asks you do to more work or
to redo what you already did :) )

On Thu, Sep 14, 2017 at 9:14 PM, Oliver Walters
<oliver.henry.walters@xxxxxxxxx> wrote:
> Adam,
>
> Both are really good points.
>
> Here's what I propose:
>
> Short Term:
>
> Move the library information / license / KLC / contributing information to
> the website. This will also include links to download library releases (from
> github)
>
> Medium Term:
>
> Provide downloads of individual libraries, which will be hosted (??
> somewhere ?? )
>
> Long Term:
>
> Full description of library elements, including image previews / metadata /
> etc. This will be searchable.
>
> Actual library data remains on GitHub, obviously.
>
> On Fri, Sep 15, 2017 at 12:01 PM, Adam Wolf <adamwolf@xxxxxxxxxxxxxxxxxxxx>
> wrote:
>>
>> I really, really like the idea of having the libraries page on the
>> KiCad website itself.
>>
>> I have run into numerous people who do not understand that the github
>> libraries are "official".  Plus, this means that *for whatever reason*
>> if the libraries move from github, the pages explaining the libraries
>> stay in the same space.
>>
>> Adam Wolf
>>
>> On Thu, Sep 14, 2017 at 7:54 PM, Oliver Walters
>> <oliver.henry.walters@xxxxxxxxx> wrote:
>> > Ben,
>> >
>> > That's also an option, I hadn't considered that! Perhaps I was focused
>> > on
>> > the GitHub-side solution too closely.
>> >
>> > Wayne, do you want to weigh in here before I spend too much further
>> > effort
>> > developing this? Could the libraries page be developed on the KiCad
>> > website
>> > itself?
>> >
>> > The structure could remain largely the same but the formatting would
>> > need to
>> > change from Jekyll to Hugo.
>> >
>> > Cheers,
>> > Oliver
>> >
>> > On Fri, Sep 15, 2017 at 1:17 AM, Ben Hest <bombledmonk@xxxxxxxxx> wrote:
>> >>
>> >> Does this method provide an advantage over doing a similar thing using
>> >> Hugo and putting the docs on the kicad-pcb.org website?
>> >> https://github.com/KiCad/kicad-website
>> >>
>> >>
>> >> - Ben
>> >>
>> >> On Thu, Sep 14, 2017 at 7:01 AM, Oliver Walters
>> >> <oliver.henry.walters@xxxxxxxxx> wrote:
>> >>>
>> >>> Hi everyone,
>> >>>
>> >>> The conversation of how best to manage and distribute KiCad libraries
>> >>> has
>> >>> been raging for a while now.
>> >>>
>> >>> Users looking to download or contribute to the libraries are currently
>> >>> presented with a github landing page and some bland wiki pages (e.g.
>> >>> for the
>> >>> KLC information).
>> >>>
>> >>> I have been working on a new-and-improved website system for the
>> >>> following:
>> >>>
>> >>> * Clear information about the libraries
>> >>> * A place to download the latest libraries
>> >>> * Information on what is *in* the libraries
>> >>> * Instructions on how to contribute to the libs
>> >>> * Better presentation of the KLC
>> >>>
>> >>> This website will need to be updated periodically to present the
>> >>> latest
>> >>> version of the libraries to the users. Also, if users are going to be
>> >>> downloading library files then it could potentially use a lot of
>> >>> bandwidth.
>> >>> Thirdly, the generated content should be scripted but statically
>> >>> hosted.
>> >>>
>> >>> The solution? GitHub pages! - https://pages.github.com/ -
>> >>>
>> >>> These are hosted from your github repository, and for e.g. ours would
>> >>> have the URL kicad.github.io - this could be easily redirected from
>> >>> kicad-lib.org/library (for example).
>> >>>
>> >>> GitHub pages use the jekyll toolset to generate static content.
>> >>>
>> >>> With a small amount of additional Python scripting I have created a
>> >>> bare-bones example of what this might look like (locally hosted on my
>> >>> laptop
>> >>> for now):
>> >>>
>> >>> Here are some screenshots! Ignore the colors and simple layout scheme,
>> >>> this is currently just a framework.
>> >>>
>> >>> https://imgur.com/a/0GELG
>> >>>
>> >>> The main objectives of this project are:
>> >>>
>> >>> a) Present a more professional landing page for the libraries
>> >>> b) Leverage GitHub Pages functionality
>> >>> c) Improve KLC
>> >>>
>> >>> And, eventually:
>> >>>
>> >>> Provide a standardised way to separate the KiCad libraries from the
>> >>> KiCad
>> >>> installer!
>> >>>
>> >>> Thoughts and comments appreciated!
>> >>>
>> >>> Cheers,
>> >>>
>> >>> Oliver
>> >>>
>> >>> _______________________________________________
>> >>> Mailing list: https://launchpad.net/~kicad-developers
>> >>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>> >>> Unsubscribe : https://launchpad.net/~kicad-developers
>> >>> More help   : https://help.launchpad.net/ListHelp
>> >>>
>> >>
>> >>
>> >>
>> >> --
>> >>
>> >> -Ben
>> >
>> >
>> >
>> > _______________________________________________
>> > Mailing list: https://launchpad.net/~kicad-developers
>> > Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>> > Unsubscribe : https://launchpad.net/~kicad-developers
>> > More help   : https://help.launchpad.net/ListHelp
>> >
>
>