kicad-doc-devs team mailing list archive
-
kicad-doc-devs team
-
Mailing list archive
-
Message #00296
Re: Documentation workflow with stable and development branch
-
To:
kicad-doc-devs@xxxxxxxxxxxxxxxxxxx
-
From:
Wayne Stambaugh <stambaughw@xxxxxxxxx>
-
Date:
Mon, 18 May 2020 08:05:21 -0400
-
Autocrypt:
addr=stambaughw@xxxxxxxxx; prefer-encrypt=mutual; keydata= mQGiBEM0hxQRBAC2fNh3YOVLu1d5GZ0SbrTNldGiGnCJPLqzEnqFX9v6jmf33TMt6EmSLkl6 Wtfkoj0nVwKxcYmJkA8DX0QAokBkwNIzhSsBzQvthBLIk/5LnPVVKrEXOcL4mUyH1doKlkaE slgJozNa6Av+oavcvD02o1zJOloBbaHlNlyRt7fKswCgtIFlVjWggVH/15KfWk+Qo5JVPbME AIUBAQyL2OAx0n60AWec2WHnO9buHuG0ibtICgUMkE+2MRmYyKwYRdyVwGoIUemFuOyHp0AJ InX4T+vy2E7vkwODqjtMLfIoRkokW74Fi4nrvjlhOAw/vdq/twLbAmR9MOfPTpR4y7kQy1O2 /n+RkkRvh26vTzfbQmrH7cBJhk6aA/9Uwvu3E4zNJgHVZeS0HyWtmR1eOPPRbnkPgJTToX5O KMKzTJI/FX6kT7cFoCamitHrW3BJP4Dx+cMMsa47EGxqVTdbVJ4LjogsXTXxb+0Fn1u4zBdx x3Cer6O7+hqWy7zvpzeC6nSREjqDKa5CgHtv/GLm5uFPOmsjAsnHj2tlBrQmV2F5bmUgU3Rh bWJhdWdoIDxzdGFtYmF1Z2h3QGdtYWlsLmNvbT6IeAQTEQIAOBYhBOffs6CbblRzBkv33BtR cWlZ+CReBQJbFBS2AhsDBQsJCAcCBhUKCQgLAgQWAgMBAh4BAheAAAoJEBtRcWlZ+CReMI8A nRbrLkzp7+c2f0vX7sfg4ICX8LAKAJ9uClo4uJajmZa5zZrL2nKdZlUwIrkCDQRDNIcxEAgA gCru+3/aOC6RCjpvYC72wY+d5SmHphC6yeiV2/mOumyt5MLo/Ps2GznZr11JspqFk5K/Zpvp MMLqqjDZ39+50a2iKRQFJ6NlK+hJWMmj6eJygQrCwYo3Gjc6CqfrqUv+8VSnf/i5sIZmtOVA 4ZjML18MuBvMSsNdVLFJd5HNnYb1iOECpvqdPVh/21LLCEw7MUUGGnHBhCrmk2aJe5hFmcSN g4ldBcXrgMQBwf7aMVoobXBMFDb/IENByXn0llB7Gr2IFMRmNS9/p8s/II1Yl2bTqyX4FSz8 cfn7C9KEz7faZ7wzAcpwHFC/zs3JoAjJ0IEKdNUpIwAlKMzT3CzctwADBQf/cxpG28MKyrqk nNmq/8LQLy+x6FSYXBLjxQz9BiBNYeesDZQ6J5UbL1mjpJzMa5tLZypPYo4bbGyR22hrbyDF K7m6AcVaMIJKl98g4ukMutFfAJyRDaREH5Zl/X1P4u1Z/yaAIy9mKaNbaK1/5djNJ5wCTFen TUgAp9xdc30kGkFDdLJFp5uxDY4P0vaZiZdjUCvDM3Zjv5IzpNOfxVqTUBQNUP/BnnKhkk0p DTD6s3X8S+D0rOtEBQ8K0cwERI/E8EFa8nj0TNw4e2MYGR8wg+SxqJ7z5f0zPY0bO6G9DDFB wYCqzzPWGqdAh9vA5971TAbPERtdFybhkurozp2SfYhJBBgRAgAJBQJDNIcxAhsMAAoJEBtR cWlZ+CResHUAniULLCWiT26ieRTl7N2vS6vBo/DuAJ4m7Ss/gyiW6ybTn1ctDXAUgm2QVQ==
-
In-reply-to:
<CAOuK9LisOEAizxeseT7Du-eEwq+unCKEoOn=dfGDizAbnQH+fw@mail.gmail.com>
-
User-agent:
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.8.0
On 5/17/20 3:53 PM, Nick Østergaard wrote:
> On Sun, 17 May 2020 at 21:00, <f.dos.santos@xxxxxxx> wrote:
>>
>> Yes, it's done :-)
>>
>> But if anyone wants to take an issue, I'll be happy too ;-)
>>
>> I've left 2 issues which involves redoing a screenshot :
>> - https://gitlab.com/kicad/services/kicad-doc/-/issues/788 the preference menu should be replaced
>> - https://gitlab.com/kicad/services/kicad-doc/-/issues/792 which also involves removing the Portable template tab
>>
>> I don't want to mix a bunch of linux based screenshot with the existing windows based screenshot.
>> Anyone does windows screenshots ?
>>
>
> In my opinion it is fine to mix screenshots from different OS'. This
> should not hold you back. But updating screenshots just to make them
> look more alike (for example same platform) when there are no changes
> in the dialogs is a bit of a waste of time.
I share this opinion. I think it's good thing to show screenshots from
all platforms given that KiCad is a cross platform application.
>
>>
>> I've also found an old issue which is interesting :
>> - https://gitlab.com/kicad/services/kicad-doc/-/issues/304
>>
>> It envolves documenting the minimum template requirement which is different between 5.1 and master :
>> - in 5.1 the project .pro file is required in the template directory
>> - in master the renaming when creating new project from template will happen even if there is no .pro file
>>
>> How do we document this 2 different behavior ?
>> I've been thinking :
>> - 1 commit on master documenting 5.1 behavior left to be cherry-pick later
>> - followed by 1 commit on master documenting v6 behavior and this one should never be cherry-pick
>
> If that works for now, please do that. If you have changes that
> applies to 5.1, don't hold them back. It is better to get it in ASAP,
> if it is easy (cherry-pick'able).
>
>>
>> Francisco
>>
>> ----- Mail original -----
>> From: "Nick Østergaard" <oe.nick@xxxxxxxxx>
>> To: "f dos santos" <f.dos.santos@xxxxxxx>
>> Date: 17/05/2020 19:19:28
>> Subject: Re: [Kicad-doc-devs] Documentation workflow with stable and development branch
>>
>> Hello Francisco
>>
>> I see you have created a bunch of detailed issues with various details
>> in the issue-tracker. I assume you are going to make some merge
>> requests at some point. Just to be sure we have not misunderstood each
>> other.
>>
>> Nick
>
Follow ups
References