Re: digiKam English documentation

Gilles Caulier <[email protected]> Wed, 21 Aug 2024 07:29:37 +0200
Newsgroups gmane.comp.kde.digikam.devel
Message-ID <CAHFG6sGmatyHaQ86Enua4qZuZmtwmPJQGFK_q4tWVZGtGOp3uA@mail.gmail.com>
Hi all,

The contribution workflow to the digiKAm documentation is well
explained (i hope) on the README from the git repository :

https://invent.kde.org/documentation/digikam-doc/-/blob/master/README.md?re=
f_type=3Dheads

Look at "Contribute Workflow" section for details.

To resume, we use the gitlab Merge Request mechanism from a forked
version of the git repository.

An alternative (but not recommended) is to make a patch of the diff in
your cloned version and send the file to me directly.

Best

Gilles Caulier

>
> I am brand new to the project, so I don=E2=80=99t know if I=E2=80=99m all=
owed to comment or not, but as a developer with over 30 years of experience=
 I can say that one of the things that slows adoption of any software is po=
or documentation.  I think the digiKam documentation is pretty good, but th=
ere=E2=80=99s always room for improvement with anything.
>
> Gilles or someone much more experienced with the project should comment w=
ith the final approval, but I don=E2=80=99t see how better documentation wo=
uld do anything but help.
>
> Cheers,
> Mike
>
> > On Aug 20, 2024, at 7:49=E2=80=AFPM, Rickey D Chapman <rick05chap@iclou=
d.com> wrote:
> >
> > I=E2=80=99ve just started using digiKam and it is incredibly well done.=
 So I want to thank the whole development team.
> >
> > But I also think the English-language documentation could be improved b=
y some grammatical editing. I have forked the documentation, setup sphinx-d=
oc and edited the first 6 rst files in the manual. (The edited files are st=
ill local on my machine as I have not yet figured out how to push my change=
s back to gitlab.)
> >
> > But then it occurred to me that maybe you don=E2=80=99t want this type =
of help. So should I continue editing, or stop? And if I continue, is there=
 a preference for either a large or small number of files in each merge req=
uest?
> >
> > Rick Chapman
>