Правила работы с Calculate Wiki

Вы находитесь в Wiki новой версии сайта Calculate Linux, где любой желающий может принять участие в составлении материала.

Цель создания Calculate Wiki

Основная и главная цель создания — дать возможность пользователям Calculate Linux принять участие в совместной работе, связанной с созданием документации по работе в системе. Работа над созданием материалов производится по определённым правилам. Введение правил даёт возможность получать материалы, которые будут максимально удобны и понятны в использовании. Не пугайтесь правил, если вы сделаете что-то не так, это всегда можно исправить.

Совет

Посмотрите имеющиеся статьи и у вас сразу появится представление в каком виде необходимо их создавать

Язык разметки материала

По результатам проведённого опроса язык разметки в новом сайте был сменён на Markdown. Сделано это было весьма вовремя, как раз накануне запуска Calculate Wiki. Спасибо Сергею, предложившему в чате @calculate_wiki перейти на новый язык и спасибо всем принявшим участие в опросе! Несмотря на то, что нам безумно нравится Textile, причин для перехода было довольно много. Правила разметки текста вы можете посмотреть, нажав восклицательный знак в верхней панели редактора, или на примере созданных материалов.

Порядок добавления статей и правок

  1. Для создания новой статьи выберите в меню Новая статья .
  2. После сохранения статьи она попадает в Песочницу и ждёт модерации и одобрения. Все материалы, не прошедшие данную процедуру, будут подсвечены желтым цветом в основном списке, а также будут доступны для редактирования и просмотра всем зарегистрированным пользователям сайта. Неавторизованным пользователям статья будет недоступна.
  3. При выполнении правок в статье обычными пользователями все изменения ждут одобрения. При добавлении предложения к изменению статьи старайтесь подробно описывать суть вашего предложения. По умолчанию отображается статья с утверждёнными правками или самая последняя версия если утверждений небыло. Материал с последними правками доступен при переходе в черновик или последнюю точку истории. Неодобренные правки в истории будут выделены жёлтым цветом.
  4. Все пользователи имеют доступ к управлению точками истории статьи с возможностью возврата к более ранней версии.

Правила написания материала

При составлении материала автор должен быть на 100% уверен в правильности изложенной информации. Использование предположений не допускается. Стиль изложения должен вестись в утвердительной форме настоящего времени.

Пример

Установка, Используется, Применяется или Установите, Используйте, Применяйте.

В каждом материале должна быть раскрыта суть вопроса в полном объёме. Пользователь, прочитавший материал, должен получить полное представление о написанном. Старайтесь использовать логику «Что - Где - Как». Перед составлением материала убедитесь, что такой темы нет. В случае, если интересующая вас тема создана, вы всегда можете предложить автору дополнения или исправления.

Стандарты обозначений

  • Доменное имя: calculate.local
  • Нумерация сетей: 192.168.0.0 дополнительные 192.168.1-9.0
  • Логины пользователей: user дополнительные user(1-20)
  • Команда установки: emerge -av (название пакета)

Правила добавления кода

Внимание! По умолчанию считается, что все команды вводятся от пользователя root. В случае выполнения команд от простого пользователя делается примечание!

Одиночная команда:

emerge -av chromium

Команда с выводом:

# rc-update add postgresql-9.6 default
 * service postgresql-9.6 added to runlevel default

Внимание! Если команда выводится не полность, то ставится троеточие в том месте, где код не показывается.

Выполнение команд по очереди:

# cd /var/www/nextcloud
# wget https://download.nextcloud.com/server/releases/nextcloud-12.0.3.zip

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

Пример:

MariаDB [(none)]> CREATE DATABASE `base` CHARACTER SET utf8 COLLATE utf8_general_ci;

Для вставки кодов необходимо использовать синтаксисис показываемого кода.

Вот примеры часто используемых вариантов:

  • Код PHP:
<?php
/*
 * Generated configuration file
 * Generated by: phpMyAdmin 4.7.5 setup script
 * Date: Sat, 18 Nov 2017 15:51:14 +0000
 */
/* Servers configuration */
$i = 0;
/* Server: localhost [1] */
$i++;
$cfg['Servers'][$i]['verbose'] = '';
$cfg['Servers'][$i]['host'] = 'localhost';
$cfg['Servers'][$i]['port'] = '';
...
  • Код Nginx:
# pmalempcss.calculate.loc
server {
        listen 80;
        server_name pmalempcss.calculate.local;
        access_log /var/www/pma/logs/pma.access_log main;
        error_log /var/www/pma/logs/pma.error_log info;
        root /var/www/pma/htdocs/;
        index index.php index.html index.htm;
        location ~ \.php$ {
               try_files $uri =404;
               include /etc/nginx/fastcgi.conf;
               fastcgi_pass unix:/run/php-fpm.socket;
           }
}
  • Код файлов параметров:
...
;PHP был установлен неверно. Запрос getenv("PATH") возвращает пустые результаты.
env[HOSTNAME] = $HOSTNAME
env[PATH] = /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin
env[TMP] = /tmp
env[TMPDIR] = /tmp
env[TEMP] = /tmp
  • Вывод команд в консоли Bash:
# psql -U nextcloud -d nextcloud -h 127.0.0.1 -W
Пароль пользователя nextcloud:
psql (9.6.6)
Введите "help", чтобы получить справку.
nextcloud-> \q

Уровни доступа пользователей

Без авторизации вы можете только читать статьи. Для авторизации используется ваша учётная запись на calculate-linux.ru. В вики есть несколько уровней доступа, обозначенных шахматными фигурами возле имени пользователя: пользователю, редактору, модератору и администратору соответствуют пешка, слон, конь и ферзь.

пользователь редактор модератор
Создание статьи в Песочнице + + +
Перенос статьи из Песочницы +
Ведение черновика изменений + + +
Принятие изменений из черновика в своей статье + + +
Принятие изменений из черновика в чужих статьях + +
Изменение заголовка +
Изменение ссылки на страницу +
Добавление хлебных крошек +
Перенос в Песочницу +
  • Пользователь - начальный уровень доступа, которым наделяется каждый зарегистрированный пользователь. "Обычный пользователь" имеет возможность создавать новые статьи, которые затем будут проверены и одобрены модератором, вносить свои правки в чужие статьи, которые могут быть приняты пользователями выше уровнем доступа. После одобрения написанной пользователем статьи, пользователь имеет право принимать правки добавленные другими пользователями, либо делать откат к предыдущей точке истории. После одобрения 10 написанных пользователем статей, уровень доступа автоматически меняется на следующий по иерархии;

  • Редактор - уровень доступа, при котором пользователь имеет возможность без премодерации вносить правки в свои и чужие статьи. При создании новой статьи "Редактор" ждёт одобрения статьи пользователем выше уровнем доступа;

  • Модератор - уровень доступа, который имеет те же права, что и "Редактор", но также имеет возможность одобрять правки и статьи, написанные другими пользователями, создавать и править статьи с иерархией, а также вносить в бан недобросовестных пользователей;

Если у вас возникли вопросы и предложения, напишите нам в группе телеграм.