Перейти к содержанию

Как стать контрибутором ОРДЫ ?

Открытые знания движут миром. И одной из важных миссией этого ресурса - является предоставление знаний в области Application Security. Мы открыты к тому, чтобы любой заинтересованный человек мог сделать вклад в этот ресурс. Это может выражаться в обновлении существующего материала, его доработка а также разработка новых статьей.

Правила

Введём некоторые правила, которые должен соблюдать каждый участник при написании материала, а также перед его отправкой:

  1. Ресурс не может выражать мнение, касамое изменений которые происходят вне Application Security.
  2. При написании статьи вы должны помнить о том, что ресурс не преследует коммерческие цели, соответственно статьи или изменения которые будут преисполнены респектом к определённому продукту/вендору не будут приниматься в основу.
  3. Любое оскорбление и унижение над участниками сообщества или организацией также будут отклонены.
  4. Материал нарушающий этически-правовые границы не принимается в наше сообщество.

Составляем статью.

Для начала необходимо, чтобы вы имели аккаунт на Github, а также базовое представление о его работе. Наш ресурс работает на MkDocs и мы должны придерживаться его гайдлайнов и принципов. Рассмотрим подробнее. Перейдя в репозиторий ОРДЫ в github - CyberORDA github. Вы можете увидить следующиуюю структуру.

Структура при входе.

Для нас имеет значение директория "Docs", которая содержит в себе все документы и статьи, которые загружены на ресурс.

Директория Docs.

Каждая статья написана в формате Markdown и имеет некоторую структуру:

---
hide:
  - feedback
tags:
  - Contributor
  - Гайд
  - Сообщество
---
Тут прописываются теги, которые будут видны на каждой странице и при помощи которых любой пользователь может быстро найти нужный контент. Также указываются плагины. Для каждой статьи необходимо использовать header, менять можно только теги.

Заголовки

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

# - заголовок 1-го уровня
## - заголовок 2-го уровня
### - заголовок 3-го уровня

Заголовки являются необходимым элементом при построенни текста. Они могут разделять контент. Мы используем жирные заголовки:

### **Жирный заголовок**
Будтет отображаться как:

Жирный заголовок

Основная часть

В основной части пишется всё необходимое содержимое статьи.

При написании текста мы можем применить форматирование:

** - для того чтобы текст был жирным
Пример:

**Жирный текст**

Будет отображаться как:

Жирный текст

Или вот:

**Жирный** текст

Жирный текст

* - для того чтобы текст был курсивным
Пример:

*Курсивный текст*

Будет отображаться как:

Курсивный текст

Или вот:

*Курсивный* текст

Курсивный текст

Тут мы можем импортировать картинки:

![Описание.](https://your.image/image.png) - картинка по центру.

{ align=left } - тег для указания положения картинки.

{ width="300" } - тег для указания размера.

к примеру:

![Орда фото](https://images.stopgame.ru/uploads/images/249721/form/1362301115.jpg){ align=center }{ width="200" }

Даст нам вот такую картинку

Орда фото

Однако, вы можете также использовать html на странице для загрузки контента:

<img src="https://images.stopgame.ru/uploads/images/249721/form/1362301115.jpg" alt="Орда фото" width="200" style="display:block; margin:auto;"/>
Это будет отображатсься так

Орда фото

Для загрузки картинок вы можете использовать postimages.co

Таблицы

При составлении контента вам может быть необходимо реализовать таблицу.

В коде это будет отображаться вот так:

| Name | Author | Description |
| ---- | ------ | ----------- |
| [APISandbox](https://github.com/API-Security/APISandbox) | [APISecurity Community](https://github.com/API-Security) | Pre-Built Vulnerable Multiple API Scenarios Environments Based on Docker-Compose. |
| [Bookstore](https://tryhackme.com/room/bookstoreoc) | [sidchn](https://tryhackme.com/p/sidchn) | TryHackMe room - A Beginner level box with basic web enumeration and REST API Fuzzing. |

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

На сайте это будет отображено вот так:

Name Author Description
APISandbox APISecurity Community Pre-Built Vulnerable Multiple API Scenarios Environments Based on Docker-Compose.
Bookstore sidchn TryHackMe room - A Beginner level box with basic web enumeration and REST API Fuzzing.

Html

Мы включили плагин для использования html в markdown. Вы можете подгружать контент с YouTube или других ресурсов, которые предоставляют эту возможность.

Вносим изменения в github.

После того как статья была создана вами, необходимо предложить изменения в github.

Для этого, мы создаём файл в директории docs:

Создаём файл

Вносим код markdown файла с статьёй, которую вы написали:

Вносим код

После этого делаем предпросмотр и нажимаем на "Commit Changes".

Дальше необходимо предоставить краткое описание того, что было сделано и сделать push

Вносим изменения.

Что было дальше?

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

До встречи и удачи!