Re: Progress is good for us but bad for documentation

2021-06-09 Thread Michael Reeves
One thing the seems entirely missing is any documentation what so ever of
craft's runtime confurable options. I'm talking things maintainers can do
in their config scripts not the end-user config file which is self
documented.

On Wed, Jun 9, 2021, 1:27 PM Frederik Schwarzer  wrote:

>
>
> On 6/9/21 6:02 PM, Johannes Zarl-Zierl wrote:
> > Hi,
> >
> > Am Mittwoch, 9. Juni 2021, 01:20:23 CEST schrieb Frederik Schwarzer:
> >> I would like to ask you to report such documentation to me. We see the
> >> topic come up here and there but it then sometimes sinks into oblivion
> >> again because it was part of a merge request that has then been merged
> >> or so.
> >> [...]
> >> So what to report? Documentation that ...
> >> - explains outdated technology or concepts like KDE 4 or HAL.
> >> - has holes in it. For example a tutorial where you suddenly think,
> >> you skipped an important step.
> >> - you wish was there but you could not find it.
> >
> > Is this an effort with universal scope, or is there a limit?
> > Obviously you are at least talking about the wikis. Are you also (at the
> > current time) talking about other websites and/or application handbooks?
>
> It is meant as an open question. All answers welcome. Of course not
> everything can be worked on now. But compiling a list of stuff to work
> on will help pushing and coordinating the work.
>
> heers,
> Frederik
>


Re: Progress is good for us but bad for documentation

2021-06-09 Thread Frederik Schwarzer




On 6/9/21 6:02 PM, Johannes Zarl-Zierl wrote:

Hi,

Am Mittwoch, 9. Juni 2021, 01:20:23 CEST schrieb Frederik Schwarzer:

I would like to ask you to report such documentation to me. We see the
topic come up here and there but it then sometimes sinks into oblivion
again because it was part of a merge request that has then been merged
or so.
[...]
So what to report? Documentation that ...
- explains outdated technology or concepts like KDE 4 or HAL.
- has holes in it. For example a tutorial where you suddenly think,
you skipped an important step.
- you wish was there but you could not find it.


Is this an effort with universal scope, or is there a limit?
Obviously you are at least talking about the wikis. Are you also (at the
current time) talking about other websites and/or application handbooks?


It is meant as an open question. All answers welcome. Of course not 
everything can be worked on now. But compiling a list of stuff to work 
on will help pushing and coordinating the work.


heers,
Frederik