← Back to team overview

kicad-developers team mailing list archive

Re: KiCad Libraries (again)

 

Oliver,

Great work!  This is really shaping up nicely.

Cheers,

Wayne

On 9/17/2017 12:13 AM, Oliver Walters wrote:
> Hugo can use external JSON data during the build step, so I've worked
> out how to list the GitHub library releases directly onto the downloads
> page!
> 
> Some progress images here:
> 
> https://imgur.com/a/2V6E3
> 
> Most of the framework is in place now. I need some assistance with
> wording for /discover/libraries but other than that, almost ready to go :)
> 
> Oliver
> 
> On Sat, Sep 16, 2017 at 1:52 PM, Oliver Walters
> <oliver.henry.walters@xxxxxxxxx <mailto:oliver.henry.walters@xxxxxxxxx>>
> wrote:
> 
>     Some more
>     progress: https://github.com/KiCad/kicad-library/issues/1622
>     <https://github.com/KiCad/kicad-library/issues/1622>
> 
>     On Sat, Sep 16, 2017 at 12:53 PM, Oliver Walters
>     <oliver.henry.walters@xxxxxxxxx
>     <mailto:oliver.henry.walters@xxxxxxxxx>> wrote:
> 
>         I have worked out how to transfer the KLC page to the Hugo
>         templating system (it is SO much harder to use than Jenkins :p) 
> 
>         Example:
> 
>         https://i.imgur.com/4kZnvOA.png <https://i.imgur.com/4kZnvOA.png>
> 
>         The libraries information is also moved across, but that's just
>         static content so it's much simpler.
> 
>         I'll keep you posted.
> 
>         On Fri, Sep 15, 2017 at 10:41 PM, Wayne Stambaugh
>         <stambaughw@xxxxxxxxx <mailto:stambaughw@xxxxxxxxx>> wrote:
> 
>             On 9/14/2017 8:54 PM, Oliver Walters 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 libraries page could be developed on KiCad website
>             although I'm not
>             sure how that would work.  I am comfortable with either
>             solution.  Pick
>             which ever solution is the most comfortable for you.  Since
>             you are
>             doing the work, you should choose the implementation unless
>             someone else
>             is willing step up and help out.  Even the basic overview
>             that you
>             presented is far better than anything we have at the
>             moment.  We can
>             always add more features later.
> 
>             >
>             > 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 <mailto:bombledmonk@xxxxxxxxx>
>             > <mailto:bombledmonk@xxxxxxxxx <mailto: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 <http://kicad-pcb.org>
>             >     <http://kicad-pcb.org>
>             >     website? https://github.com/KiCad/kicad-website
>             <https://github.com/KiCad/kicad-website>
>             >     <https://github.com/KiCad/kicad-website
>             <https://github.com/KiCad/kicad-website>>
>             >
>             >
>             >     - Ben
>             >
>             >     On Thu, Sep 14, 2017 at 7:01 AM, Oliver Walters
>             >     <oliver.henry.walters@xxxxxxxxx
>             <mailto:oliver.henry.walters@xxxxxxxxx>
>             >     <mailto:oliver.henry.walters@xxxxxxxxx
>             <mailto: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
>             <http://kicad.github.io> <http://kicad.github.io> -
>             >         this could be easily redirected from kicad-lib.org/library <http://kicad-lib.org/library>
>             >         <http://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
>             <https://launchpad.net/~kicad-developers>
>             >         <https://launchpad.net/~kicad-developers
>             <https://launchpad.net/~kicad-developers>>
>             >         Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>             <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>             >         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx
>             <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>>
>             >         Unsubscribe :
>             https://launchpad.net/~kicad-developers
>             <https://launchpad.net/~kicad-developers>
>             >         <https://launchpad.net/~kicad-developers
>             <https://launchpad.net/~kicad-developers>>
>             >         More help   : https://help.launchpad.net/ListHelp
>             <https://help.launchpad.net/ListHelp>
>             >         <https://help.launchpad.net/ListHelp
>             <https://help.launchpad.net/ListHelp>>
>             >
>             >
>             >
>             >
>             >     --
>             >
>             >     -Ben
>             >
>             >
>             >
>             >
>             > _______________________________________________
>             > Mailing list: https://launchpad.net/~kicad-developers
>             <https://launchpad.net/~kicad-developers>
>             > Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>             <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>             > Unsubscribe : https://launchpad.net/~kicad-developers
>             <https://launchpad.net/~kicad-developers>
>             > More help   : https://help.launchpad.net/ListHelp
>             <https://help.launchpad.net/ListHelp>
>             >
> 
> 
>             _______________________________________________
>             Mailing list: https://launchpad.net/~kicad-developers
>             <https://launchpad.net/~kicad-developers>
>             Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>             <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>             Unsubscribe : https://launchpad.net/~kicad-developers
>             <https://launchpad.net/~kicad-developers>
>             More help   : https://help.launchpad.net/ListHelp
>             <https://help.launchpad.net/ListHelp>
> 
> 
> 
> 


Follow ups

References