← Back to team overview

kicad-developers team mailing list archive

Re: Documenting environment variables

 

Seconded.  We could use more focused but in-depth articles, even if they're
not perfectly appropriate for reference documentation.

Adam

On Sun, Jun 24, 2018, 5:10 PM hauptmech <hauptmech@xxxxxxxxx> wrote:

> Hi Eeli,
>
> It's really cool you wrote this up. I encourage you to publish this as a
> blog article, or an informational post on kicad.info once you are happy
> with it. Ironically it's more likely to be read and used there than the
> official documentation.
>
> -hauptmech
>
> On 25/06/18 08:30, Eeli Kaikkonen wrote:
>
> Thanks for the feedback. I don't feel need to aim this for the official
> documentation. I can of course host it where it is now or put it in a git
> service. And it certainly won't be "ready" for the 5.0 release. Right now
> the factual content is the most important. It's meant to help especially
> those who need to change configurations for e.g. KiCad 4 + 5 combination,
> so I just keep it available and try to enhance it little by little. If I'll
> get comments, I'll gather and store them for future editing sessions.
> Possible factual errors I try to fix immediately.
>
> Eeli Kaikkonen
>
> su 24. kesäk. 2018 klo 22.56 Wayne Stambaugh (stambaughw@xxxxxxxxx)
> kirjoitti:
>
>> Hi Eeli,
>>
>> This is a good first start but it definitely needs some work before it's
>> ready for the kicad documentation.  I don't see this being ready for the
>> stable 5 release unless someone has some time to step up and clean up
>> the grammar and overly verbose writing.  I'm also not sure where this
>> document would live.  The KiCad documentation seems like a good choice
>> but it also might be reasonable to break it into specific app related
>> pieces.
>>
>> Cheers,
>>
>> Wayne
>>
>> On 06/23/2018 06:45 AM, Eeli Kaikkonen wrote:
>> > As I have said earlier, I have written a document about KiCad and
>> > environment variables. It ended up being larger than I expected. It
>> > handles even some tangential subjects and my style is verbose. Still I
>> > hope it could be useful. I need feedback. Facts are of course the most
>> > important, but I also take constructive criticism about the content in
>> > general, structure and English grammar (I'm not a native speaker).
>> >
>> > It was suggested that maybe this could be added to the official
>> > documentation. I'm open to different possibilities. I'm ready to
>> convert
>> > the document to a different format.
>> >
>> > Here's the link:
>> >
>> https://docs.google.com/document/d/1Rq8i2Ay7qpGpffaj-AQmE-Xp88ikHhgyt0Ygpi8717o/edit?usp=sharing
>> >
>> > Eeli Kaikkonen
>> >
>> >
>> > _______________________________________________
>> > 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
>

References