Page 1 of 1

Поддержка Вики проекта / Project Wiki Support

Posted: Tue Mar 26, 2024 1:42 am
by bad_Dr3dd0x
Всем доброго.
Я... Хотел бы начать с того, что то, что есть сейчас - могло бы быть лучше. Но, как говорится в старой пословице, "хочешь лучше - делай сам", верно?
Я беру на себя обязанность обновлять информацию на вики (на русскоязычных страницах так точно). И уже начал редактировать страницы, приводя их к единому шаблону (спасибо тем, кто также переписывает вики). На данный момент, я считаю эталонной страницей http://wiki.kolibrios.org/wiki/CEDIT, так что если решите что-то написать - руководствуйтесь её дизайном.
В моих планах:
= переименовать Template App 2.0 в application, а Application в application_en, и привести его к виду App-2.0 (чтобы не было путаницы, и англичане тоже смогли заценить :D )
= унификация дизайна страниц - планируется для облегчения делать по категориям (сейчас переписываю "Офисные приложения")
= замена скриншотов программ на свежие (если это возможно)
= Некоторые статьи стоит добавить на титульную страницу вики или распределить по уже существующим категориям
= Добавление статей тех программ, которых в вики нет
= Переписывание и дополнение того, что уже есть
= Написание гайда по оформлению статьи (важная штука, я считаю)
= Еще было бы неплохо подцепить куратора англоязычной вики, так как с английским у меня есть определённые трудности (боюсь, что переводчик может исказить смысл или потерять его вовсе), пусть я и могу делать достаточно точный перевод самостоятельно.

Физическая поддержка приветствуется. Предложения - тоже (но всё-таки помощь лучше). Хейтеры - идите лесом.

p.s.
Spoiler:Q: Почему именно вики, а не программирование?
A: Первое: я откровенно слаб в программировании, хотя и понимаю его базовые принципы и логику. Второе: без документации и черт ногу сломит. Третье: я не люблю бардак. Четвёртое: в документации я буду максимально полезен.

Q: Сообщество запланировало переезд на Git, почему ты хочешь поддерживать wiki?
A: MediaWiki и справка Git имеют совершенно разные структуры. Git представляет из себя подобие книги-гайда с разделами и главами. MediaWiki - это массив знаний, между которыми можно перемещаться как угодно.

Q: Есть текстовая документация в виде файлов .txt, . md, есть репозиторий, на котором всё хранится.
A: Не смешивайте понятия. Документация для разработчиков - это документация для разработчиков. В вики может быть указана история разработки, какие-то важные вехи, изменения, : ~~веселые истории у костра~~. Вики - это энциклопедия, которая берёт материалы из репозитория, форума и предоставляет всё в одном месте. Это - человеческое общее представление того, что уже есть.

=====[ for English users: ]=====


I... would like to start by saying that what we have now could be better. But as the old saying goes, "if you want better, do it yourself," right?
I take it upon myself to update the information on the wiki (this is exactly the case on Russian-language pages). And I have already started editing the pages, bringing them to a single template (thanks to those who also rewrite the wiki). At the moment, I consider the reference page to be http://wiki.kolibrios.org/wiki/CEDIT, so if you decide to write something, follow this design.
In my plans:
= rename Template App 2.0 to application, and Application to application_en, and bring it to the form App-2.0 (so that there is no confusion, and the British could also check it out :D )
= unification of page design - it is planned to make it easier by category (now I am rewriting "Office applications")
= replacing screenshots of programs with fresh ones (if possible)
= Some articles should be added to the front page of the wiki or divided into existing categories
= Adding articles of those programs that are not in the wiki
= Rewriting and supplementing what is already there
= Writing an article design guide (an important thing, I think)
= It would also be nice to pick up a curator of an English-language wiki, since I have certain difficulties with English (I'm afraid that the translator may distort the meaning or lose it altogether), even though I can do a fairly accurate translation on my own.

Physical support is welcome. Suggestions are the same (but still help is better). The haters are passing by.

p.s.
Spoiler:Q: Why wiki and not programming?
A: The first: I am frankly weak in programming, although I understand its basic principles and logic. Secondly, without documentation, the devil will break his leg. Third: I don't like a mess. Fourth: I will be as useful as possible in the documentation.

Q: The community has planned to move to Git, why do you want to support wiki?
A: MediaWiki and Git help have completely different structures. Git is a kind of a guide book with sections and chapters. MediaWiki is an array of knowledge between which you can navigate as you like.

Q: There is text documentation in the form of files.txt, . md, there is a repository where everything is stored.
A: Don't confuse concepts. Developer documentation is documentation for developers. The wiki may contain the development history, some important milestones, changes, : ~~funny campfire stories~~. A wiki is an encyclopedia that takes materials from a repository, a forum and provides everything in one place. This is a human general vision of what already exists.

Re: Поддержка Вики проекта / Project Wiki Support

Posted: Tue Mar 26, 2024 2:32 pm
by rgimad
Зачем раздел "Ошибки, баги"? Для этого есть баг трекер/issues

Re: Поддержка Вики проекта / Project Wiki Support

Posted: Wed Mar 27, 2024 2:23 pm
by bad_Dr3dd0x
rgimad wrote: Tue Mar 26, 2024 2:32 pm Для этого есть баг трекер/issues
Тогда, я думаю, есть два варианта.
1. Оставить раздел с ссылкой на багрепорты на конкретных страницах
2. Убрать раздел

Re: Поддержка Вики проекта / Project Wiki Support

Posted: Wed Mar 27, 2024 2:42 pm
by rgimad
в варианте 1 все равно надо будет следить за тем что пофиксено, что нет и причем вручную. На баг-трекере или что мы юзаем там всегда актуальная инфа. В принципе можно было бы вставлять сслыку на тег баг-трекера типа somebugtracker.com/tag/myprogram который выдает сразу актуальный список багов по myprogram. Но, вроде на мантисе такого нет, на гитее не смотрел

Re: Поддержка Вики проекта / Project Wiki Support

Posted: Wed Mar 27, 2024 3:06 pm
by bad_Dr3dd0x
rgimad wrote: Wed Mar 27, 2024 2:42 pm В принципе можно было бы вставлять сслыку на тег баг-трекера типа somebugtracker.com/tag/myprogram который выдает сразу актуальный список багов по myprogram. Но, вроде на мантисе такого нет, на гитее не смотрел
На Mantis такого действительно нет. Баги могут быть указаны только по номерам, но не по тексту описания.

Re: Поддержка Вики проекта / Project Wiki Support

Posted: Fri Mar 29, 2024 8:52 pm
by Sweetbread
rgimad wrote: Wed Mar 27, 2024 2:42 pm на гитее не смотрел
https://git.kolibrios.org/KolibriOS/kol ... &labels=26