wikiotics.org
1.0.0
Wikiotics - это веб -сайт для изучения иностранного языка.
Проект Wikiotics был основан в 2008 году с целью создания свободно лицензированной вики, где люди могли бы сотрудничать в материалах для изучающих язык. В рамках этого мы построили вики -двигатель под названием Ductus, который предоставил основу для создания интерактивных страниц вики из структурированного контента, редактируемого из веб -браузера. В 2011 году Wikiotics присоединился к усилиям с проектом Wikibabel, проектом с аналогичным видением и чей разработчик продолжил внести значительный вклад в викиотики. Несколько лет спустя мы потеряли интерес к поддержанию протоков и заняты другими видами деятельности.
По состоянию на июль 2020 года викиотики были переведены на статический сайт. В то время как это был вики, Wikiotics.org получил взносы от 62 зарегистрированных пользователей, а также анонимных пользователей, идентифицированных только по их IP-адресу. Всего было 4064 такого вклада, каждый из которых имеет соответствующий коммит в этом хранилище (запрос № 4). Этот репозиторий предназначен для того, чтобы служить рабочим архивом работы сообщества. Разработка нового контента также возможна, учитывая достаточный интерес.
Содержание немного беспорядочно, как и следовало ожидать от хранилища, который был редактирован всеми в мире, без умеренности. Кроме того, единственный реальный способ увидеть рабочий черновик урока - это спасти его в вики.
Первый шаг вперед - очистить контент. Уроки и страницы, которые не полезны, должны быть удалены. (Они останутся в истории GIT, если мы когда -нибудь захотим их ссылаться.) Любой урок, который еще не полезен, может быть отмечен draft = true и, таким образом, скрыт от основной сборки веб -сайта. Когда несколько копий одного и того же содержания консолидируются, следует оставить псевдоним в любом старом месте (ах), так как мы давно следовали принципу, который прохладный URI не меняется.
Любой, кто внес свой вклад в вики и имеет учетную запись на GitHub, может претендовать на свои взносы, отправив запрос на вытягивание, который добавляет соответствующую запись в файл .mailmap в этом хранилище. Эта запись должна составить карту [email protected] по адресу электронной почты, связанного с учетной записью Github (или, в качестве альтернативы, адрес [email protected] ).
Требование взносов таким образом будет означать, что профиль пользователя связан в истории GitHub любой страницы, в которую внес вклад в (пример здесь). К сожалению, на данный момент кажется, что график вкладов не учитывает файл .mailmap . Это несовместимо с отчетом о переполнении стека, но, вероятно, связано с этим обсуждением по экземпляру GitHub. Интересно, что приложение Fasthub-Libre правильно отображает график взносов, полностью.
Wikiotics теперь статический сайт, построенный с Hugo. Следующие шаги позволяют отредактировать его локально:
Установите Hugo.
На Ubuntu это так же просто, как
$ sudo snap install hugo --channel=extended
Прямо сейчас, «расширенная» версия не требуется, но мы можем экспериментировать с ее функциями в будущем.
Клонировать это хранилище:
$ git clone https://github.com/wikiotics/wikiotics.org.git
Запустите сервер разработки Hugo и укажите веб -браузер на предоставленный URL:
$ cd wikiotics.org
$ hugo server
[...]
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop
Контент находится в content/ каталоге. При сохранении любого файла контента веб -браузер должен автоматически обновляться с обновленным контентом.
Каждый урок полностью представлен Front Matter Toml, который содержится между линиями, которые говорят +++ . При редактировании урока один совет - временно установить grid = true в своем переднем веществе, которое будет отображать элементы урока в качестве таблицы. Это может быть полезно для получения глобального взгляда на урок. Уроки, для которых draft = true также будут отображаться в виде сетки (то есть, если проекты включены).
Каждый урок может быть аннотирован с языком, который он преподает, и, если это применимо, язык, который он предполагает, что учащийся знает, устанавливая target-languages и/или source-languages на переднем крае урока, следуя стандартным определениям этих терминов. За кулисами эти аннотации являются случаями таксономий Хьюго.
Схема именования вики (для URL/маршрутов) обсуждается в #12. Мы также планируем документировать (#9) и улучшить (#10) структуры данных TOML для уроков.
Наибольшим приоритетом на данный момент является улучшение представления архива сайта.
Добавление нового урока медиа в настоящее время будет включать координацию изменений в репозитории Wikiotics Media. Рассматриваются две альтернативы: GIT Большой хранилище файлов и IPFS (подробности в #15).
Весь контент (то есть все в content/ каталоге, рекурсивно) лицензируется по лицензии Creative Commons Attribution-Sharealike 3.0. Некоторые из уроков средств массовой информации (ссылки, но не включенные в этот репозиторий) доступны по другой (но бесплатной) лицензии Creative Commons. Все остальное (например, весь код) доступно в рамках общей общедоступной лицензии GNU или любой более поздней версии. Некоторые из библиотек в {assets,static}/ductus/ доступны в рамках более разрешительных лицензий.
Нам нравится, чтобы все было простым, после годов наличия довольно сложного технологического стека. (Еще до этого нам удалось избежать многих излишек современного развития фронта.) Поддерживать простые вещи помогает максимизировать коэффициент автобуса и минимизировать время, затрачиваемое на поддержание сайта. Там не должно быть или мало движущихся частей, и в идеале нет сервера для обслуживания.
Мы опираемся на следующие технологии, чтобы помочь достичь наших целей:
