← Back to team overview

kicad-developers team mailing list archive

Re: [PATCH] V5 upgrade documentation

 

I have put the upated image live now, and it seems to work. I will try to
revert the removal of the macros.

Den tor. 28. jun. 2018 kl. 23.21 skrev Nick Østergaard <oe.nick@xxxxxxxxx>:

> Hi Seth
>
> Ok, thank you for your investigation. I will update the docker image to
> bionic which uses 0.52 of po4a.
>
> Nick
>
> Den tor. 28. jun. 2018 kl. 23.05 skrev Seth Hillbrand <
> seth.hillbrand@xxxxxxxxx>:
>
>> ​Bother.  po4a fixed this back in 2016 (
>> https://github.com/mquinson/po4a/commit/86f79e5d341ffcb62da9812101304c3dbb420cc6).
>> It looks like our doc server is running 0.47 (the fix didn't get released
>> until 0.49)
>>
>> -S
>>
>>
>>
>> Am Do., 28. Juni 2018 um 12:39 Uhr schrieb Wayne Stambaugh <
>> stambaughw@xxxxxxxxx>:
>>
>>> Hey Adam,
>>>
>>> It will eventually be in the Kicad documentation at
>>>
>>> http://docs.kicad-pcb.org/stable/en/kicad.html
>>>
>>> There were some github macros that hauptmech added that broke the
>>> documentation build.  Apparently asciidoc was choking on them which is
>>> unfortunate as they made the github adoc conversion and viewing much
>>> nicer than our vanilla adoc files.  The commit to fix this was made
>>> 14hrs ago so it should be built soon.  Once the website is updated, you
>>> should be able to grab the link.  If you don't see it within 24 hours,
>>> please let me know an I will see if I can get it resolved.
>>>
>>> Cheers,
>>>
>>> Wayne
>>>
>>> On 6/28/2018 1:32 PM, Adam Wolf wrote:
>>> > Hi Wayne,
>>> >
>>> > Has it been decided where this documentation will live?  Is it some
>>> > place with a URL?
>>> >
>>> > Thanks!
>>> >
>>> > Adam
>>> > On Sun, Jun 24, 2018 at 11:24 AM Wayne Stambaugh <stambaughw@xxxxxxxxx>
>>> wrote:
>>> >>
>>> >> hauptmech,
>>> >>
>>> >> I merged your patch and pushed the changes upstream to the kicad doc
>>> >> repo.  Thank you for the help with the documentation.
>>> >>
>>> >> Cheers,
>>> >>
>>> >> Wayne
>>> >>
>>> >> On 06/23/2018 08:54 PM, hauptmech wrote:
>>> >>>
>>> >>> Attached
>>> >>>
>>> >>> On 24/06/18 02:46, Wayne Stambaugh wrote:
>>> >>>> Hey hauptmech
>>> >>>>
>>> >>>> For the most part I'm fine with these changes.  I think that the
>>> first
>>> >>>> two paragraphs (sentences) in the "Schematic Symbol Libraries"
>>> section
>>> >>>> of the version upgrade document could be merged into a single
>>> paragraph
>>> >>>> since they are related.
>>> >>>>
>>> >>>> If no one else objects to these changes, please create a merge
>>> request
>>> >>>> and I'll merge them into my repo and push them upstream today or
>>> >>>> tomorrow.
>>> >>>>
>>> >>>> Thanks for the help.
>>> >>>>
>>> >>>> Cheers,
>>> >>>>
>>> >>>> Wayne
>>> >>>>
>>> >>>> On 06/23/2018 12:15 AM, hauptmech wrote:
>>> >>>>> Hi Wayne,
>>> >>>>>
>>> >>>>> Really awesome that you are creating this documentation!
>>> >>>>>
>>> >>>>> A couple thoughts:
>>> >>>>> * No one reads documentation unless they have to. Usually after
>>> stabbing
>>> >>>>> in the dark for a while.
>>> >>>>> * If one has to read documentation, one wants it short and to the
>>> point.
>>> >>>>> * Whatever basic knowledge you want the reader to have about how
>>> kicad
>>> >>>>> works, they won't have it.
>>> >>>>>
>>> >>>>> With that in mind I did a little example editing with the following
>>> >>>>> goals:
>>> >>>>>
>>> >>>>> * Link to any info that is a requirement for understanding this
>>> >>>>> document. If you can't find any existing documentation to link to,
>>> >>>>> that's a good clue that we need to fill in more info locally.
>>> >>>>> * Leave out as many extra words as possible.
>>> >>>>>
>>> >>>>>
>>> https://github.com/hauptmech/kicad-doc/blob/master/src/kicad/kicad_upgrading_from_v4_to_v5.adoc
>>> >>>>>
>>> >>>>>
>>> >>>>>
>>> https://github.com/hauptmech/kicad-doc/blob/master/src/eeschema/eeschema_symbol_library_table.adoc
>>> >>>>>
>>> >>>>>
>>> >>>>>
>>> >>>>> It's not formatted as a patch because I only edited a few
>>> paragraphs,
>>> >>>>> and in those I rewrote things completely as an example of the
>>> above.
>>> >>>>>
>>> >>>>>
>>> >>>>>
>>> >>>>>
>>> >>>>> On 23/06/18 04:10, Wayne Stambaugh wrote:
>>> >>>>>> I pushed the v5 upgrade document to my personal repo[1] on git
>>> hub.  I
>>> >>>>>> made it part of the KiCad documentation but I don't have a strong
>>> >>>>>> opinion about where to add it.  This just seemed like the most
>>> logic
>>> >>>>>> place.  Please review it when you get a chance.  If you find any
>>> issues
>>> >>>>>> let me know, send me a patch, or submit a pull request against my
>>> doc
>>> >>>>>> repo.  Keep in mind that this document is only to detail the
>>> changes
>>> >>>>>> that will effect project compatibility with older versions of
>>> kicad and
>>> >>>>>> the perils of symbol remapping.  Thanks in advance for the help.
>>> >>>>>>
>>> >>>>>> Cheers,
>>> >>>>>>
>>> >>>>>> Wayne
>>> >>>>>>
>>> >>>>>> [1]:
>>> >>>>>>
>>> https://github.com/stambaughw/kicad-doc/blob/master/src/kicad/kicad_upgrading_from_v4_to_v5.adoc
>>> >>>>>>
>>> >>>>>>
>>> >>>>>>
>>> >>>>>> _______________________________________________
>>> >>>>>> 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
>>> >>>>>
>>> >>>>>
>>> >>>>> _______________________________________________
>>> >>>>> 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
>>> >>>> _______________________________________________
>>> >>>> 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
>>> >>>
>>> >>>
>>> >>>
>>> >>>
>>> >>> _______________________________________________
>>> >>> 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
>>> >>>
>>> >>
>>> >> _______________________________________________
>>> >> 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
>>>
>>> _______________________________________________
>>> 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
>>>
>> _______________________________________________
>> 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
>>
>

Follow ups

References