← Back to team overview

kicad-doc-devs team mailing list archive

Re: Documentation workflow with stable and development branch

 

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