[Kicad-developers] [PATCH] V5 upgrade documentation
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@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp >From 870401845b1bb785dcb7b3ff3d40bec185921ac4 Mon Sep 17 00:00:00 2001 From: Hauptmech Date: Sat, 23 Jun 2018 13:36:38 +1200 Subject: [PATCH] Simplify language and add some background info the reader may lack. MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="2.17.0" This is a multi-part message in MIME format. --2.17.0 Content-Type: text/plain; charset=UTF-8; format=fixed Content-Transfer-Encoding: 8bit --- .../eeschema_symbol_library_table.adoc| 22 +++--- src/kicad/kicad_upgrading_from_v4_to_v5.adoc | 73 ++- 2 files changed, 47 insertions(+), 48 deletions(-) --2.17.0 Content-Type: text/x-patch; name="0001-Simplify-language-and-add-some-background-info-the-r.patch" Content-Transfer-Encoding: 8bit Content-Disposition: attachment; filename="0001-Simplify-language-and-add-some-background-info-the-r.patch" diff --git a/src/eeschema/eeschema_symbol_library_table.adoc b/src/eeschema/eeschema_symbol_library_table.adoc index fc60bb42..18a3a753 100644 --- a/src/eeschema/eeschema_symbol_library_table.adoc +++ b/src/eeschema/eeschema_symbol_library_table.adoc @@ -1,14 +1,17 @@ == Manage Symbol Libraries -Symbol libraries need to be made available in order to create schematics. -The manner in which this is accomplished varies according to the version -of KiCad being used. +Symbol libraries hold collections of symbols used when creating schematics. Each symbol +in a schematic is uniquely identified by a full name that is composed of a library nickname +and a symbol name. An example is `Audio:AD1853`. === Symbol Library Table -As of November 2017, Eeschema uses a new library management tool based on -*_symbol library tables_* which is identical in design to the footprint -library table used in CvPcb and Pcbnew. +The symbol library table holds a list of all library files KiCad knows about. +The symbol library table is constructed from the global
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
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@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp >>> >>> >>> ___ >>> Mailing list: https://launchpad.net/~kicad-developers >>> Post to : kicad-developers@lists.launchpad.net >>> Unsubscribe : https://launchpad.net/~kicad-developers >>> More help : https://help.launchpad.net/ListHelp >> ___ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp > > > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
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 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@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > >>> > >>> > >>> ___ > >>> Mailing list: https://launchpad.net/~kicad-developers > >>> Post to : kicad-developers@lists.launchpad.net > >>> Unsubscribe : https://launchpad.net/~kicad-developers > >>> More help : https://help.launchpad.net/ListHelp > >> ___ > >> Mailing list: https://launchpad.net/~kicad-developers > >> Post to : kicad-developers@lists.launchpad.net > >> Unsubscribe : https://launchpad.net/~kicad-developers > >> More help : https://help.launchpad.net/ListHelp > > > > > > > > > > ___ > > Mailing list: https://launchpad.net/~kicad-developers > > Post to : kicad-developers@lists.launchpad.net > > Unsubscribe : https://launchpad.net/~kicad-developers > > More help : https://help.launchpad.net/ListHelp > > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
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 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@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp >>> >>> >>> >>> >>> ___ >>> Mailing list: https://launchpad.net/~kicad-developers >>> Post to : kicad-developers@lists.launchpad.net >>> Unsubscribe : https://launchpad.net/~kicad-developers >>> More help : https://help.launchpad.net/ListHelp >>> >> >> ___ >> Mailing list: https://launchpad.net/~kicad-develop
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
No problem, thanks for everything! On Thu, Jun 28, 2018 at 2:38 PM Wayne Stambaugh wrote: > > 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 > > 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@lists.launchpad.net > >> Unsubscribe : https://launchpad.net/~kicad-developers > >> More help : https://help.launchpad.net/ListHelp > > > > > > ___ > > Mailing list: https://launchpad.net/~kicad-developers > > Post to : kicad-developers@lists.launchpad.net > > Unsubscribe : https://launchpad.net/~kicad-developers > > More help : https://help.launchpad.net/ListHelp > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > >>> > >>> > >>> > >>> > >>> ___
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
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 < stambau...@gmail.com>: > 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 > 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@lists.launchpad.net > >> Unsubscribe : https://launchpad.net/~kicad-developers > >> More help : https://help.launchpad.net/ListHelp > > > > > > ___ > > Mailing list: https://launchpad.net/~kicad-developers > > Post to : kicad-developers@lists.launchpad.net > > Unsubscribe : https://launchpad.net/~kicad-developers > > More help : https://help.launchpad.net/ListHelp > ___ > Mailing list: https://launchpad.net/~kicad-developers > >>>
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
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.hillbr...@gmail.com>: > 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 < > stambau...@gmail.com>: > >> 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 >> 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@lists.launchpad.net >> >> Unsubscribe : https://launchpad.net/~kicad-developers >> >> More help : https://help.launchpad.net/ListHelp >> > >> > >> > _
Re: [Kicad-developers] [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 : > 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.hillbr...@gmail.com>: > >> 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 < >> stambau...@gmail.com>: >> >>> 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 >>> 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 >>> >> >>> >> >>> >> >>> >> ___
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
On Fri, Jun 29, 2018 at 12:00:21AM +0200, Nick Østergaard wrote: > 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 : > > > Hi Seth > > > > Ok, thank you for your investigation. I will update the docker image to > > bionic which uses 0.52 of po4a. > > > > Nick Veery good, thanks! -- Marco Ciampa I know a joke about UDP, but you might not get it. GNU/Linux User #78271 FSFE fellow #364 ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
Does this mean that we will be able to put the github macros back into the adoc file? I also checked the latest doc build and I did not see the version upgrade section in the kicad documentation as if the include statement failed. Any ideas or am I missing something? Wayne On 06/28/2018 05:21 PM, Nick Østergaard wrote: > 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 > mailto:seth.hillbr...@gmail.com>>: > > 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 > mailto:stambau...@gmail.com>>: > > 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 > mailto:stambau...@gmail.com>> 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
Re: [Kicad-developers] [PATCH] V5 upgrade documentation
Thanks Nick! On 06/28/2018 06:00 PM, Nick Østergaard wrote: > 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 > mailto:oe.n...@gmail.com>>: > > 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 > mailto:seth.hillbr...@gmail.com>>: > > 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 > mailto:stambau...@gmail.com>>: > > 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 > mailto:stambau...@gmail.com>> 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/bl
