[doc] Промежуточный отчёт Wiki

[Даниил Захаров]

Давайте переместим, мне нужно для этого FTP и, наверное, лучше выделенную базу (чтобы исключить проблемы с таблицами от других ресурсов), её имя, логин и пароль к ней:)
Под инструкцией я подразумевал некоторые технические моменты, такие как: файл настроек (т.е. LocalSettings для самого движка), передачу управляющей учётной записи, а также комментарий к текущим настройкам проекта (например, в текущей конфигурации отключена возможность править и создавать страницы для всех, кроме администраторов).


29.03.2018, 00:01, "Vladislav Ivanishin" <ivladak at yandex.ru>:
> Добрый день!
>
> Даниил Захаров <mr.danz at yandex.ru> writes:
>
>>  Доброго дня.
>>
>>  Представляю промежуточный отчет по проекту Wiki.
>>  Развернута и доступна Wiki по адресу compilers.csmsu.ru . В данный момент на ней создано 36 страниц (не считая Main Page):
>>  All.h
>>  Data
>>  FAQ
>>  QBE
>>  Tmp0
>>  Арифметические и битовые операции
>>  Блоки
>>  Вариативность
>>  Инструкции
>>  Инструкции Cast и Copy
>>  Инструкции QBE
>>  Инструкция Call
>>  Инструкция Phi
>>  Константы
>>  Объявления
>>  Память
>>  Переходы
>>  Подтипы
>>  Преобразования
>>  Примеры кода QBE IL
>>  Простые типы данных
>>  Составные типы данных
>>  Сравнения
>>  Структура Blk
>>  Структура Fn
>>  Структура Ins
>>  Структура Op
>>  Структура Ref
>>  Структура Tmp
>>  Структура Use
>>  Теория к заданиям
>>  Функции
>>  Функция fillpreds
>>  Функция fillrpo
>>  Функция filluse
>>  Функция ssa
>>
>>  В соответствии с заявленным планом:
>>  1) Страница QBE будет содержать общее описание языка;
>>  2) Описание языка. Под этим подразумевается русификация и разбиения на отдельные страницы имеющейся документации c9x.me/compile/;
>>  3) Отдельными страницами планируется описать неофициальный Си-интерфейс, с описанием и разбором содержимого его файлов;
>>  4) Примеры кода QBE IL;
>>  5) Различные проблемы, которые могут возникнуть при написании программ на языке QBE, либо с использованием Си библиотеки;
>>  6) Некоторые теоретические части из лекций.
>>
>>  выполнены все пункты. Однако, это не означает завершенность проекта (потому отчет промежуточный, а не итоговый).
>>  Нам осталось/мы планируем доработать следующие вещи:
>>  1) На главной странице сейчас, помимо плана, появилось размеченное содержание
>>  перевода оригинальной документации. Необходимо будет разметить и выложить (уже
>>  по завершению проекта) содержание всего Wiki (то есть сделать навигацию по
>>  проекту) для облегчения ориентирования по ней;
>>  2) Плагин DoxyWiki оказался нерабочим. Половина его репозиториев "мертвые". По
>>  этой причине, взаимодействие с другой частью нашей команды, работающей над
>>  документацией к коду Си-интерфейса с помощью doxygen, нам видится как разметка и
>>  "перелинковка" страниц Wiki с их документацией. Отмечу, что это лишь
>>  предположение, и допускаю возникновение каких-либо проблем, не позволяющих
>>  воплотить вышеуказанную идею. Тем не менее, мы создали страницу "All.h"
>>  (http://compilers.csmsu.ru/wiki/All.h), которая является "входной" для страниц с
>>  "нашей" документацией к некоторым структурам и функциям одноименного файла
>>  Си-интерфейса. Возможно, нашим коллегам по команде эти страницы смогут помочь
>>  при выполнении своей работы.
>>  3) На странице "Теория к заданиям" реализуется 6-й пункт плана проекта. Пока что
>>  ее содержание не является итоговым, оно будет редактироваться и, хотелось бы,
>>  чтобы пополнилось разъяснениями/комментариями к терминам, используемыми в 3-м
>>  блоке заданий ejudge.
>
> Благодарю за подробный отчёт и проделанную работу.
>
>>  В заключении, хотелось бы вынести на дискуссию формат итогового отчета по
>>  проекту. По моему мнению, формат у каждого проекта свой, но в нашем случае, план
>>  может быть таким:
>>  1) Краткое описание самого проекта;
>>  2) Описание особенностей оформления страниц;
>>  3) Комментарии по настройке движка MediaWiki (для преподавателей);
>>  4) Ссылка на копию Wiki и вызгрузку её базы данных.
>
> Если не затруднит, могли бы вы c Александром переместить wiki на сервер
> практикума (83.149.198.179) и продолжить разработку там? Это бы сразу
> покрыло пункт 4. Нужные права выдадим.
>
> В остальном меня предложенный формат устраивает. В принципе, это не так
> важно. Достаточно небольшой инструкции, чтобы мы смогли пользоваться
> плодами ваших усилий (и поддерживать документацию в актуальном
> состоянии) и
>
>     Отчёт должен включать в себя описание статуса всех изначально
>     запланированных задач, общее состояние готовности проекта и оценку
>     его успешности.
>
> , как сказано в мега-сообщении номер 14 в архивах prac-sp-18. Моря там
> писать на надо -- просто резюме. Саму вики и сообщения в рассылке мы
> видим; лучше сослаться, чем дублировать лишний раз.
>
>>  С уважением,
>>  Захаров Даниил
>>  _______________________________________________
>>  doc mailing list
>>  doc at compilers.ispras.ru
>>  https://compilers.ispras.ru/cgi-bin/mailman/listinfo/doc
>
> --
> Влад

С уважением,
Захаров Даниил