Skip to content

Commit

Permalink
gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
cryals committed Aug 16, 2024
1 parent 43ea3a4 commit 51a5ce2
Show file tree
Hide file tree
Showing 9 changed files with 1,233 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
node_modules
.vitepress/cache
.vitepress/dist
.vitepress/.temp

### Obsidian ###
.obsidian/

### Sublime Text ###
*.sublime-workspace
*.sublime-project
GitHub.sublime-settings

### Visual Studio Code ###
.vscode/
.history/

### JetBrains ###
.idea/

### .env ###
docs/.env
3 changes: 3 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Для авторов

В данном разделе расположены различные правила и советы для авторов. Здесь вы найдёте полезную информацию о том, как создавать и редактировать статьи на вики. Ознакомьтесь с этими правилами и советами, чтобы улучшить свои навыки авторства на NEWERA STATION WIKI.
126 changes: 126 additions & 0 deletions docs/reference/pages/alteration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Внесение изменений

:::info
Для внесения изменений необходимо иметь профиль на GitHub.
:::

## 1. Создаём fork репозитория

### 1.1. Заходим на [GitHub проекта](https://github.com/OlegShchavelev/ALTRegularGnomeWiki):

![github_main](/alteration/github_main.png)

### 1.2. Переходим на вкладку Fork и нажимаем [[Create fork]]:

![github_fork_create](/alteration/github_fork_create.png)

:::info
После небольшого ожидания репозиторий появится в вашем профиле GitHub.
:::

## 1.3. Клонируем созданный fork на локальный компьютер:

::: code-group

```shell[https]
git clone https://github.com/USER/ALTRegularGnomeWiki.git
```

```shell[ssh]
git clone git@github.com:USER/ALTRegularGnomeWiki.git
```

:::

`USER` — имя вашего пользователя GitHub.

## 2. Добавляем необходимую информацию и создаём commit.

Перед внесением изменений ознакомьтесь с [правилами](./general-rules.md) и [возможностями VitePress](./vitepress.md).

После того как добавили всё необходимое, выполните следующие команды:

### 2.1. Добавляем изменения в индекс git:

::: tabs
== Терминал

```shell
git add *
```

== VSCodium
Нажимаем [[+]] около имени файла

![indexing_via_vscodium](/alteration/indexing_via_vscodium.png)
:::

### 2.2. Создаём commit:

::: tabs
== Терминал

```shell
git commit -m "commit message"
```

Замените `commit message` на описание ваших изменений.
== VSCodium
Добавляем описание и нажимаем [[Фиксация]]

![indexing_via_vscodium](/alteration/indexing_via_vscodium.png)
:::

:::info
Описание необходимо писать на русском языке.

Также мы рекомендуем следующие приставки:

Добавлено: \
Обновлено: \
Удалено:

_Например_

```
Обновлено: Для авторов | Страница приложения
```

:::

### 2.3. Отправляем изменения на GitHub:

::: tabs
== Терминал

```shell
git push
```

== VSCodium
Нажимаем [[Синхронизировать изменения]]

![indexing_via_vscodium](/alteration/sync_changes_via_vscodium.png)
:::

## 3. Создаём pull request

### 3.1. Возвращаемся в ваш fork на GitHub:

![github_fork](/alteration/github_fork.png)

### 3.2. Выбираем `Contribute` и нажимаем [[Open pull request]]:

смотрим что нет никаких проблем и нажимаем [[Create pull request]]

![pr_no_error](/alteration/pr_no_error.png)

### 3.3. Заполняем и нажимаем [[Create pull request]]:

::: warning
Пожалуйста, прикрепите к своему первому PR ваш ник в Telegram! Это необходимо для связи и добавления в рабочие чаты.
:::

![pr_create](/alteration/pr_create.png)

После этого остаётся только подождать пока одобрят ваш PR.
27 changes: 27 additions & 0 deletions docs/reference/pages/general-rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Общие правила

Данные правила распространяются на все страницы Wiki.

## Создание страницы

- Все страницы создаются в Markdown файлах.
- Файл необходимо поместить в нужную вам категорию внутри папки `docs`.
- Названия файлов прописываются в нижнем регистре.
- Если название файлов состоит из нескольких слов, разделите их дефисом, например: 'gnome-software.md'.
- Для добавления страницы в меню, пропишите её в файле `/_data/navigations.ts`.

## Темы

- Не описывайте темы противоречившие законодательству Российской Федерации:

- Любые способы анонимизации пользователей и сетей для использования заблокированных сервисов.
- Запрещённое программное обеспечение и сервисы.
- Пиратство.

- При использовании информации с внешних ресурсов необходимо указать источник в конце статьи.

## Наполнение

- Используйте скриншоты только со стандартными темами окружения GNOME.
- Описывайте лишь проверенные темы и приложения.
- Не используйте опасные для пользователя и/или системы команды.
Loading

0 comments on commit 51a5ce2

Please sign in to comment.