olegshchavelev/altregulargnomewiki

библиотека знаний операционной системы ALT Regular Gnome

ALT Gnome Wiki

База знаний открытого сообщества пользователей операционной системы ALT Linux с графическим окружением GNOME.

Разработка

Перед запуском проекта убедитесь, что у вас установлены необходимые компоненты

sudo apt-get install node git

Выполним загрузку репозитория, перейдём в каталог проекта и запустим в режиме разработки

git clone https://github.com/OlegShchavelev/ALTGnomeWiki.git
cd ALTRegularGnomeWiki
npm i
npm run docs:dev

Дополнительный функционал

Включение динамической сортировки участников на главной странице

Для работы функции требуется создать read-only токен GitHub

(Оффициальный REST API GitHub не предоставляет данные об активности в репозитории без авторизации. Поэтому для использования данного функционала требуется ключ с правом на чтение публичных репозиториев)

Как это сделать можно прочитать тут

Далее для локального использования нужно создать файл .env в папке /docs/ и добавить в него данную строку:

VITE_GIT_KEY="{ваш токен}"

(Данный файл добавлен в исключения .gitignore, можно не бояться, что он уйдет в репозиторий)

А для использования функционала в сборке нужно создать secret c названием VITE_GIT_KEY для GitHub Actions в вашем репозитории

Как это сделать можно ознакомиться здесь

После этого будет доступен функционал сортировки.

(На данный момент данный ключ используется только в .vitepress/composables/git/stats.js, если вы не доверяете проекту - вы можете проверить как ваш ключ используется ведь все компоненты имеют открытый исходный код. Либо вы можете просто не использовать данный функционал. Все остается на ваше усмотрение.)

Настройки динамической сортировки

• homeTopLimit - Лимит отображаемых пользователей на главной странице
• home_filter_type - Тип сортировки пользователей на главной странице
• page_filter_type - Тип сортировки пользователей на странице команды

1. 'additions' - по количеству добавленых в репозиторий строк
2. 'commits' - по количеству коммитов в репозиторий
3. 'role+additions' - по роли участника (Разработчик -> Участник) и количеству добавленых в репозиторий строк
4. 'role+commits' - по роли участника (Разработчик -> Участник) и количеству коммитов

• enable_autosearch - Включено/выключено автозаполнение перечня участников из статистики
• loading_placeholders - Массив с возможными выводами у спиннера загрузки виджета

Зеркало

Вся документация из этого репозитория размещается на сайте alt-gnome.wiki автоматически.

Лицензия

MIT Copyright © 2023-present OLEG SHCHAVELEV

altregulargnomewiki's Issues

Не очевидная очистка всех загрузочных разделов

Только вчера поставил себе ALT Regular Gnome.

После завершения установки и перезагрузки, вылезло окно на пару секунд, вида DOS, где было написано, что-то в духе "Reset boot". В общем, я не успел понять что происходит, в итоге на соседнем диске снес загрузочный раздел Windows.

Неприятная ситуация, как восстановить не знаю.

Перевод мобильный бар

Необходимо перевести: Appearance -> Тема

Внедрить пакет Page properties

Пример на странице:
https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-page-properties/

Реализовать возможность добавлять автора/ов статьи.

Решение по добавлению авторов:
https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-git-changelog/

Возможность добавить видео из видеохостинг Rutube, VK, Youtube и другие

Ввод аналогично, проблеме #82
Установить пакет https://github.com/appdev-academy/markdown-it-youtube-vimeo

Указать канонический адрес страницы

Для поисковых систем, требуется указать канонический адрес страницы

SSL сертификат

Отсутствует сертификат при скачивании образа.

Добавить возможность подписи к изображению

Добавить возможность подписывать изображение
vuejs/vitepress#892

Пропорция логотипа в мобильной адаптации

Поправить пропорции высоты и ширины логотипа:

Статья для мейнтейнеров

Очень не хватает пошаговой инструкции как добавить пакет в сизиф с нуля(На альт вики всё это есть, но нет юзер френдли❤️)

Добавить секцию на главную странице

Пример секции:

Реализовать возможность shiki устанавливать приветствие

Руслан Хихин пишет...

небольшое замечание к статье - нигде не вижу от какого пользователя какие команды выполняются.

Необходимо, реализовать фильтрацию, в зависимости от содержания кода, добавлять приветствие. Символ приветствия не должен попадать в буфер обмена при копировании.

Браузер Firefox автоматически включает перевод страницы

На странице в теги html атрибут land указан не корректное значение. Изменить значение en-US на ru-RU

Автоматизация meta::description

По правилам поисковых систем, на каждой странице должен быть уникальный description, на текущий момент он дублируется.

Внедрить плагин референс

Внедрить плагин для парсера markdown-it:
https://www.npmjs.com/package/@luckrya/markdown-it-link-to-card

General edits

Предлагаю внести глобальные общие правки, а именно:

• Добавить методологию Kanban для создания задач на основе issue. Это позволит упростить работу в команде, так как каждый сможет наглядно видеть, как работает проект, и брать задачи, которые ему подходят. Для этого можно использовать бота в Telegram, который будет добавлять задачи в соответствующий список.

• Снова... поменять структурный подход, ибо я говорил, там демо больше, и вот сейчас я предлагаю правильный подход. Пример ниже. Это создаст удобную иерархию файлов, а так же позволит добавлять пути вида - /app/guide.html, /app/build.html. Когда основная информация о приложении будет располагаться на /app.html

• Сделать генераторы навигации, и вообще разгрузить конфиг (он у вас слишком жирный), как я сделал генератор rewrites

• Надо добавить всё же несколько префиксов, ведь когда-нибудь, просто напросто придётся пересесть на uri вида /apps/app.html /system/app.html, /problems/issue.html (Пусть о проблемах знают уже из вики, так для новокеков будет видна работа, что над этим занимаются, а для опытных задача для решения) если, что я могу индексированные страницы исключить из такой иерархии, пока другие страницы не проиндексируются. Вообще проект ток развивается, как я вижу, и если сделать очень подробную вики, люди сами потянутся

• Пришла в голову идея с переездом с vitepress на alt_vitepress (Раз я всяко быстрее внедряю что-либо, даже не зная языка)

Жду ответа, и правок от остальных участников

Скорректировать список социальных сетей

Добавить социальную сеть https://vk.com/alt_gnome

Рефакторинг markdown

На текущий момент языковой файл можно указать через конфигурацию. Можно удалить hook, а сам языковой файл добавить в конфигурацию.

Добавить рендер галереи для оформления статей ALT Gnome Wiki

Добавить галерею с возможностью отображения следующими типами:

• grid
• slider

Возможность подписывать изображения и включать лайтбокс при необходимости

Скорректировать ReadMe и профиль репозитория ALTRegularGnomeWiki

В readme необходимо добавить зеркало alt-gnome.wiki, так же добавить теги на страницу репозитория:

• ALTLinux
• ALTRegularGnome
• ALTGnomeWiki

Обновление главной страницы

Предлагаю добавить иконку со ссылкой не только на GitHub, но и на GitFlic. Также добавить рядом с ссылкой на talagram канал ссылу на репозиторий в github.

Реализовать функционал похожие статьи / приложения

Арсений

а что если мы будем, например, в расширениях или приложениях предлагать похожие? например, в статье про firefox будем предлагать chromium или наоборот. а в статье про какой-нибудь dash to dock - dash to dock lite или dash to panel

Изменить копирайт в подвале

Добавить копирайт:
Содержание доступно по лицензии MIT
© 2023 ALT Regular Gnome Community, разработано на платформе VitePress 1.0.0-rc.24

Добавить favicon

Отсутствует favicon, добавить в соответствие рекомендациями поисковой системы

Добавить информационные бейджи в блок описания, в разделе "Установка и обновление программ"

Пример:
https://shiki.style/packages/vitepress

Внедрить Enhanced Readabilities

Ссылка на документацию:
https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-enhanced-readabilities

Перевести 404

Отсутствует перевод на русский язык.

Добавить рендер: Установить из Центра приложений

Добавить метку в md, которая будет вызывать блок с кнопкой. При нажатии на кнопку в операционной системе открывается Центр Приложений, на детальной карточки приложения. Пользователю необходимо только нажать кнопку установить.

Примеры для реализации:

snapcraft
gdm-settings

Необходимо принять решение, должен ли пользователь самостоятельно выбирать источник, или источник должен определяться меткой

Добавить лицензию MIT

Необходимо добавить лицензию MIT в репозиторий, а так же сделать ссылку на лицензию в подвале проекта и ReadMe

Добавить разметку Open Graph

Добавить разметку Open Graph в соответствиях с рекомендации поисковых систем

Добавить боковой бар к статье.

Разработать боковой бар, по содержанию он будет напоминать блока Центра Приложений

В него входит содержание:

• Логотип приложения
• Сайт проекта
• Packages
• Помочь с переводами
• Сообщить о проблеме
• Лицензия
• Авторы приложения

Визуальный прототип

Перевести кнопку в секции Участники на главной странице

Перевести Sponsors -> Поддержать

Переконфигурировать проект, поддержка TypeJS

Разрешить использования TypeJS в файлах config, theme

Внедрить плагин TODO

Внедрить плагин TODO использую плагин для парсера markdown-it:
https://www.npmjs.com/package/markdown-it-todo

Добавить иконки в блок features на главной странице

Подобрать иконки, добавить их в проект, внести их в разметку блока features на главной странице.

добавление к статье

Нашел команду решающую проблему с раскладкой в статье https://alt-gnome.wiki/steam.html#не-работают-клавиши-управления-в-игре-при-нативном-запуске-без-proton
-input_button_code_is_scan_code прошу добавить в статью

Добавить модуль Changelog & File history в VitePress

Ссылка на пакет:
https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-git-changelog/

Enhanced Readabilities, ревизия от 01 января 2024 года.

Перевести


Сконфигурировать значения по-умолчанию

Перенести массив с информацией об участников в отдельный файл.

Пример реализации:
по ссылке

Добавить Markdown Containers: Alignment, Highlights

Необходимо вести несколько новых Markdown Containers с помощью:

Alignments
https://vitepress-theme-default-plus.lando.dev/markdown/alignments.html

Highlights
https://vitepress-theme-default-plus.lando.dev/markdown/highlights.html

Пример для реализации.
https://github.com/lando/vitepress-theme-default-plus

Добавить возможность публиковать видео

Реализовать возможность добавлять видео:

• C внешний ресурсов
• Локальные ресурсы.

Внешний вид плеера подойдет:

https://beautiful.makie.org/examples/animations/scatter_size

Главная страница, в ноутбуке заменить изображение на изображение с ALT Regular Gnome

Подготовить новое изображение и заменить

Ссылки на скачиваемые образы на главной странице

У меня есть предложение, чтобы на главной странице были две ссылки, на current и tested сборки, с указанием даты сборки и кратким пояснением, чем они отличаются, это было бы уместно, если пользователь хочет протестировать новейшую сборку.

На главной странице, разработать дорожную карту проекта

Необходимо подобрать компонент, спроектировать секцию и внедрить в проект Vitepress

Ревизия ошибок при запуске локального проекта. Ошибка The language 'patch' is not loaded, falling back to 'txt' for syntax highlighting.

При запуске проекта локально:
The language 'patch' is not loaded, falling back to 'txt' for syntax highlighting.

Необходимо обсудить метод дебагинга данного типа ошибок.

Структурирование страниц приложений

Из-за отсутствия общей структуры, страницы приложений сильно различаются, предлагаю внести следующие изменения:

• Привести описание всех приложений в вид "[Название] — это [описание]"

---

• Отсортировать источники установки в таком порядке

  • Установка из репозитория (если есть)
  • Установка c помощью Flatpak (если есть)
  • Установка c помощью Snap (если есть)
  • Установка c помощью EPM (если есть)
  • Установка из репозитория GitHub (если нет в Sysphus)
  • Установка с официального сайта (если нет на GitHub)
  • Установка из исходного кода (если собранного пакета нет)

Добавить элементы ввода с клавиатуры

К примеру [[ctrl]], выводим как <kbd>Ctrl</kbd>

Добавить рендер ссылок

Немножко улучшим отображение ссылок, компонент:
https://nolebase-integrations.ayaka.io/pages/en/integrations/markdown-it-bi-directional-links/

Оптимизировать логотип

Размер логотипа, 1024x1024 оптимальный размер 36x36. Добавить атрибуты width и height

Расширить иконпак проекта

Добавить в спрайт популярные социальные сети. К примеру для отображения социальных сетей в карточке участника проекта.