Kstars handbook outdated

[Yuri Chornoivan]

середа, 8 червня 2022 р. 21:37:05 EEST Hy Murveit написано:
> Jens,
> 
> I had the same idea a while back, and even made one edit in some KDE wiki,
> but, as I vaguely recall, it turned out that the wiki wasn't set up for the
> general public to contribute to. E.g. you needed an account to make
> additions, and so on. I guess to prevent it from being spammed?

Yes, we had very nasty spam attacks on UserBase several years ago. But it's 
completely functional. It's the community that lost faith in it.

> If you want to check it out, and figure out how to make it work, that would
> be great! Here is what I started:
> https://invent.kde.org/education/kstars/-/wikis/KStars-Wiki
> 
> Yuri has said that he would help folks who wanted to contribute but had
> issues with the docbook format or the source control, e.g. he said the if
> folks sent him the text and images and he'd deal with the docbook code and
> source control.
> 
> Honestly, what we really need is for someone to take on management of the
> project, if it is to be designed by us.  A wiki-style handbook would be
> great too, I think. Do you know how to set that up?

Not that great. If you look into other project wikis/docs the major problem is 
not the format but as you say, "someone to take on management". GIMP, 
Inkscape, Audacity, Krita, Fedora, openSUSE, almost every single project in 
FOSS has the problem with docs.

There will be much initial enthuasiasm which burns out in a few years. 
Something like a star evolution on Hertzsprung-Russell diagram.

My proposal is to concentrate on the smaller updates (red dwarf) rather on 
changing platform and major rewrites (blue giant).

Just my 2 cents.

Best regards,
Yuri

> 
> Hy
> 
> 
> 
> On Tue, Jun 7, 2022 at 4:47 AM Jens Scheidtmann <jens.scheidtmann at gmail.com>
> wrote:
> > Jasem, Hy,
> > 
> > I take it that the kstars/doc folder in git contains the handbook, right?
> > In my experience, having to use a version control system is a major
> > hurdle for people to contribute - even for developers.
> > 
> > Is there a wiki rendition or something similar that we could use instead?
> > Do you have any experience with Google Docs or some such? And how it
> > responds to a crowd editing the documentation?
> > Could the KDE Community Wiki be leveraged? See https://community.kde.org/
> > 
> > What do you think?
> > 
> > All the Best, Jens
> > 
> > Am So., 5. Juni 2022 um 19:19 Uhr schrieb Hy Murveit <murveit at gmail.com>:
> >> I've tried several times to get someone new to volunteer to be in charge
> >> of the handbook. I've almost succeeded twice!
> >> 
> >> There are several forum posts that, paraphrased, say "I'd like to
> >> contribute but I can't code".
> >> 
> >> Perhaps it's time for a new forum post that says "looking for someone to
> >> be responsible for KStars/Ekos documentation"?
> >> 
> >> Hy
> >> 
> >> On Sun, Jun 5, 2022, 9:33 AM Jasem Mutlaq <mutlaqja at ikarustech.com>
> >> 
> >> wrote:
> >>> Hello Steve,
> >>> 
> >>> Yes, we've been behind in updating the documentation and should probably
> >>> bring everything up to date by 3.6.0 release.
> >>> 
> >>> --
> >>> Best Regards,
> >>> Jasem Mutlaq
> >>> 
> >>> On Sun, Jun 5, 2022 at 7:22 PM steve <stax at ik.me> wrote:
> >>>> Hi,
> >>>> 
> >>>> I am currently translating that document to French.
> >>>> 
> >>>> https://docs.kde.org/trunk5/en/kstars/kstars/index.html
> >>>> 
> >>>> The version of that document is based on version 3.5.4 of the
> >>>> application.
> >>>> 
> >>>> As you very well know, current KStars version is 3.5.9. Some Ekos
> >>>> modules have enjoyed many improvements since 3.5.4. So current
> >>>> published
> >>>> handbook is outdated.
> >>>> 
> >>>> I wanted to know what were the plans for this documentation. Will it be
> >>>> updated, and if yes when and based on which version?
> >>>> 
> >>>> Thank you
> >>>> 
> >>>> Best regards
> >>>> 
> >>>> steve