kicad-doc-devs team mailing list archive

[Mathias Neumann <alfrede@xxxxxxxxxxxxxxxxxx>]

Hi at all,

as a new Member in the Documentation Team i have read this discussion 
and want to say my opinion about the Workflow with a stable and a 
developer branch.

1) It makes sense to have a developer Branch (master) and an stable.

My suggestion is that the stable documentation contains the suitable 
Screenshots and the Documentation for the Features which are build in 
for the major Releases like 5.0 or 5.1

2) The Developer branch is for the Versions like 5.1.1 5.1.2 .... in 
this branch the Developer of the Functions must contain a lowlevel 
description how the function work and a screenshot which we can take and 
bring it to the stable branch. This makes writing the documentation 
easier because we still have the pictures an must not extra make them.

3) Before we can do the two point above we must do a cut and clear the 
old issues and see which are still to do and which not. For example the 
oldest issue (https://gitlab.com/kicad/services/kicad-doc/-/issues/154) 
is four years old, so for me as a younger member i don't know what to do 
with this.

Can we took an Version for example 5.2 or 5.3 in which we have a tidy up 
Issue list and the documentation has Screenshots which are suitable for 
the Version?

The Last Point i want to discuss is, can we make a little Video tutorial 
where a new Person can easily see what to do when he want to begin 
writting the docs.


Mathias

On 18.05.20 14:53, Marco Ciampa wrote:
> On Mon, May 18, 2020 at 08:05:21AM -0400, Wayne Stambaugh wrote:
> > 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.
> +1