Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

github docs recognition #213

Merged
merged 1 commit into from
Jun 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/decision.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: To open a discussion and documentation for a key decision about the proje
title: Decide on <TOPIC>
labels: decision
assignees: ''

---

- **Impact**:
Expand All @@ -17,8 +16,6 @@ assignees: ''
- @seporterfield (? / 5️)
- @Monstarrrr (? / 5️)

- **Last updated**: [DD-MM-YYYY]

## Context <!--optional -->

[Communicate what this decision is about exactly; the importance of it;]
Expand Down
96 changes: 0 additions & 96 deletions .github/workflows/decision.yml

This file was deleted.

File renamed without changes.
File renamed without changes.
19 changes: 13 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Official repository of [rebutify.org](https://rebutify.org)
- [1.1 Environment Variables](#11-environment-variables)
- [1.2. Docker](#12-docker)
- [1.3. Python](#13-python)
- [Unix OS](#unix-os)
- [Windows OS](#windows-os)
- [Unix OS](#unix-os)
- [Windows OS](#windows-os)
- [2. Deployment](#2-deployment)
- [3. Contributing](#3-contributing)

Expand All @@ -36,21 +36,28 @@ docker compose up

## 1.3. Python

**Install** the dependencies in a new virtual environment from the root directory ``/rebutify``.
**Install** the dependencies in a new virtual environment from the root directory `/rebutify`.

```bash
python -m venv .venv
```
----

---

#### Unix OS

```bash
source .venv/bin/activate
```

#### Windows OS

```bash
source .venv/Scripts/activate
```
----

---

```bash
pip install -r requirements.txt
```
Expand All @@ -65,4 +72,4 @@ gunicorn --bind 0.0.0.0:8000 -k uvicorn.workers.UvicornWorker rebutify.asgi:appl

# 3. Contributing

For instructions on contributing, read [CONTRIBUTING.md](governance/CONTRIBUTING.md).
For instructions on contributing, read [CONTRIBUTING.md](./CONTRIBUTING.md).
54 changes: 0 additions & 54 deletions docs/decisions/_template.md

This file was deleted.

60 changes: 0 additions & 60 deletions docs/decisions/architecture/api-paradigm.md

This file was deleted.

48 changes: 0 additions & 48 deletions docs/decisions/architecture/automating-api-docs_DECISION.md

This file was deleted.

Loading