far2l
far2l copied to clipboard
elfmz
far2l web site
I have a feelings the Far2L is strong enough to have a dedicated web site, at least the landing page + list of actual links.
I understand it is not so comfortable to manage it by hands; but what about repository with static texts in any format you like, Markdown for example?
As I've checked, far2l.org is free for now.
I guess, the possible way might be the following:
- Register far2l,org $15/year
- Use let's encrypt for free https certificate for it
- GitHub repository with static texts
- GitHub Actions to populate it as static HTML site (like AWS S3, or any other option you prefer)
I am willing to help you with site maintenance, by the way.
Or maybe you have better idea, so any feedback is appreciated.
Thank you.
But what it will provide what github can't? Even github's features not used fully due to lack of time (Discussions, Wiki..)
Отдельный сайт скорее всего лишнее, т.к. некому его оперативно поддерживать актуальным, а вот завести тут в гите changelog.txt с кратким описанием наиболее значительных изменений между версиями (и по ходу дела пополнять) было бы неплохо - ибо по коммитам выискивать что полезное завелось дело совсем гиблое.
Хотя, кратко - это ещё постараться сделать: между 2.6.2 и 2.6.3 за 9 дней изменений как минимум аж на 4 строки набежало:
changelog mentions only major changes
*** version to 2.6.3 (Jul 25, 2024)
Common: Panels resize by Ctrl+(Shift+)Down allows to hide command line,
subsequently allowing fast file find without pressing Alt
Common: UI/UX minor cosmetic
WSL: fix clipboard in WSL for GUI & add clipboard support in WSL for TTY
macOS: make background fill color to be palette[0] under MAC
*** version to 2.6.2 (Jul 16, 2024)
А какой нибудь git log --no-merges --pretty=format:"%as: %b" не покатит? Ну профильтровать его от 'внутренних' изменений...
А какой нибудь
git log --no-merges --pretty=format:"%as: %b"не покатит? Ну профильтровать его от 'внутренних' изменений...
Ну это ситуацию "дело совсем гиблое" лишь немного улучшает, но всё-равно для чтения сторонним потребителем требует дальнейшего ручного причёсывания. Лучше changelog вести в процессе разработки, внося лишь значимые изменения.
Я про сайт собственно чего задал вопрос - некуда ткнуть в виде "вот начните отсюда". Все очень разрозненно. Не в гит же отправлять ;-) А будет сайт - хотя бы виде списка ссылок "смотрите также" - уже будет некая точка сборки. И обновлять его раз в несколько месяцев, когда новый релиз выходит.
в гит же отправлять
А почему и нет? Я против излишнего дублирования сущностей. Временами вот стараемся стартовый текст в README.md сделать более внятным для новичков - давайте присоединяйтесь с улучшениями/дополнениями и сокращениями лишнего. А если наберется много материала, то тогда можно будет настойчиво рекомендовать @elfmz что-то и в его https://github.com/elfmz/far2l/wiki вносить.
Про чейнджлог. Я годами собирал важное для статей на Хабре. Руками просто выписывал в текстовой файлик, когда случалось что-то интересное. Но последний год не очень активно вёл его.
сейчас наиболее востребовано не changelog, а условная wiki. Ее сильно не хватает, т.к. far2l расползается на кучу платформ, имеет кучу особенностей под разными desktop.
я предлагаю пойти следующим путем
- создать репозиторий https://github.com/elfmz/far2l-docs
- поделиться правами на него с активными пользователями . намек на @akruphi и @unxed .
- настроить в репозитории статический сайт mkdocs , а конкретнее на теме https://squidfunk.github.io/mkdocs-material/getting-started/ . Все строится на markdown плюс обработке на python. Это просто очень, сейчас для colorer делаю. Вот как по ссылке выглядит, так же можно сделать легко
- наполняем туда информацией, структурируем её. С той же вики @akruphi кучи инфо, но читать там на портянке очень тяжело
- дополнять можно будет через те же PR
- вуаля, у нас сайт https://elfmz.github.io/far2l-docs . Указать его в инфо репозитория как основную точку документации/правды
чуть сложнее. Я бы предложил завести на github организацию far2l, туда же переместить и основной код проекта. Сделав там реу под сайт можно получить https://far2l.github.io/ . сложнее тут не с технической точки зрения, делается это легко. Сложнее с именем -) а точно far2l ? а если завтра решишь перейти на 3 версию мажорную (я не про клон far3, а именно свою версию), то имя может быть уже странным far2l 3.1 . Но если тут дискомфорта нет, то организация far2l - только в путь. была идея еще far for linux - far4l , но это еще больше путаницы вызовет.
Создание сайта с инфой для новичков и удобной структурой для пользователей любого уровня поддерживаю. Только кто этим займётся? При этом регулярный changelog также полезен.
С той же вики @akruphi кучи инфо, но читать там на портянке очень тяжело
Ну я наверное уже повыгорел структурировать, а не просто более-менее аккуратно пополнять https://github.com/akruphi/far2l/wiki Оно как изначально наполнилось всей толщью кое-как уложенных откровений @unxed с времен внесения им поддержки kitty, win32 input mode и iTerm2, так теперь неспеша и пополняется, если тут в issue или в дружном чате https://t.me/far2l_ru или в комментах к статьям @unxed на хабре, проскользнёт вопрос, на который в вики нет ответа.
Если из всего этого делать полноценную доку, то тут я только на подхвате и точно не возьмусь всё переводить на английский.
я думаю, если появится возможность, то общими усилиями набьем информацию. просто для примера https://colorer.github.io и то, с чего он строится https://github.com/colorer/colorer.github.io - реально, только текст, никаких мега усилий
а пока , честно гооворя, стыдно, что проект и FAQ для него живут в разных местах. Так еще и на "главной" о FAQ ни слова (не увидел)
для примера https://colorer.github.io/
Красиво и полезно :+1:
Так еще и на "главной" о FAQ ни слова (не увидел)
Плохо смотришь - в README скромно в конце раздела "Useful 3rd-party extras" ссылка. А куда ты ссылку про такой неофициальный и не всегда корректный (я там иногда очень лажу писал неразобравшись) wiki передвинул бы?
да, совсем скромно. ну а почему бы и не в главной wiki? с пометкой "требует уточнения".
Хм, а вот какую задачу должен решать именно сайт (или даже wiki)? Может быть, лучше, сосредоточиться на интерактивной справке far2l, её наполнять и причёсывать? Там работы ещё непочатый край, полно неактуальной windows legacy инфы, про новые фичи не все рассказано, а где рассказано — не везде точно.
До сайта/wiki пользователь ещё должен добраться, а справка — она вот, всегда под рукой.
Из потенциального содержимого пока в голову приходит только лайфхаки по сборке / запуску на каких-то специфических платформах, в каких-то конкретных эмуляторах терминала. Этой инфе (может быть) и правда место не в справочной системе, а где-то на сайте. Чтобы не требовалось постоянно справку апдейтить описанием новых костылей при часто апдейтящихся версиях окружения.
какую задачу должен решать именно сайт (или даже wiki)? Может быть, лучше, сосредоточиться на интерактивной справке far2l,
Одно другому не мешает.
Сталкиваюсь с тем, что многие вокруг просто не умеют (или не любят) пользоваться внутренней справкой. Им проще через поисковик згуглить запрос и быстро получить ответ, чем рыться по справке, особенно когда много разделов. Даже мне, когда правлю/актуализирую что-то в help, иногда не всегда чётко понятно почему нужная инфа именно в этом разделе - если б не помнил, что нужная инфа точно была и её нужно актуализировать, то может и не нашёл бы.
Я может человек старой формации... но по мне так сайт нужен для того, чтобы можно было на него отсылать тех, кому это важно / нужно.
Потому что сейчас ситуация несколько анекдотична - приходит ко мне мой знакомый, и с ходу - жаль что фара нету под убунту. Я ему - как нету, есть! А... на что я должен дать ссылку? На пачку несвязанных между собой репозиториев на гитхабе? Или на статьи на хабре?
Пришлось писать ему инструкцию - вот тут пропиши, вот тут скачай, вот тут выполни, вот тут глянь как настроить, вон там скрипт с шорткатами...
А всего-то надо -- сайт-визитка с одной страничкой, где комбик (ваша система) и большая кнопка - выполнить / поставить.
Я тикет и составил ;-)
писать ему инструкцию
А приложите сюда эту инструкцию - вместе подумаем как из неё полезным дополнить/скорректировать текущий https://github.com/elfmz/far2l/blob/master/README.md
Заодно интересны соображения что в README.md не хватает? Что лишнее? Почему на README.md текущем виде нельзя послать новичка?