Skip to content

Commit

Permalink
Setup mkdocs documentation website (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
lysnikolaou authored Dec 2, 2024
1 parent cc55d07 commit c554a4b
Show file tree
Hide file tree
Showing 15 changed files with 314 additions and 207 deletions.
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# mkdocs documentation
/site
7 changes: 5 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@ repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-yaml
args: ["--unsafe"]
- id: end-of-file-fixer
- id: trailing-whitespace
- id: check-yaml
- id: requirements-txt-fixer
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.19
hooks:
- id: mdformat
additional_dependencies:
- mdformat-gfm
- mdformat-mkdocs
- mdformat-frontmatter
13 changes: 13 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.12"

mkdocs:
configuration: mkdocs.yml

python:
install:
- requirements: requirements.txt
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,6 @@
# PyGreece Community Knowledge Base
# pygreece community

Connecting Python enthusiasts worldwide – fostering collaboration, inclusivity, and
community growth.
### What is this repository?

## Background

Welcome to the Community repo of PyGreece. The Community repo stands as the knowledge base
of the PyGreece Community. More detailed, it's an attempt to share with the world all the
recourses and the processes we follow.

## Sharing Knowledge

As mentioned above, we aim to share all resources we have inside this repository. We'll
share detailed instructions on how someone can contribute to the repo soon :)

## Greek Translation of the Python Documentation

One of our main project is the translation of the Python docs to the Greek language. You
can find more information about the project
[here](https://github.com/pygreece/python-docs-gr/).

## Join the PyGreece Discord Server

The PyGreece discord server aims to connect all the members of the greek python community
in one place. You can join the server by following this link:
https://discord.gg/gWcXmDw8Yj

## PyGreece Code of Conduct

Please read carefully our code of conduct: [GR](code-of-conduct/gr.md) /
[EN](code-of-conduct/en.md)
This repository has all the content published on the
[officical PyGreece website](https://pygreece.org).
6 changes: 3 additions & 3 deletions organization/about/gr.md → docs/el/about.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Σχετικά με το PyGreece
# Σχετικά με το PyGreece

## Αποστολή
## Αποστολή { #mission }

Το PyGreece είναι μια κοινότητα της Python με έδρα την Ελλάδα. Δημιουργήθηκε στην Πράγα,
τον Αύγουστο του 2023 από μέλη της ελληνικής κοινότητας Python. Σκοπός του PyGreece είναι
να υποστηρίξει τη διαφορετικότητα και συμπερίληψη στην ελληνική κοινότητα της Python, να
προωθήσει τη χρήση της γλώσσας προγραμματισμού Python στην Ελλάδα και να οργανώσει
εκδηλώσεις με επίκεντρο τη γλώσσα προγραμματισμού Python ώστε να το υποστηρίξει.

## Στοιχεία Οργανισμού
## Στοιχεία Οργανισμού { #organization-details }

Η κοινότητα του PyGreece εκπροσωπείται από το PyGreece AMKE, έναν μη κερδοσκοπικό
οργανισμό, διοικούμενο αποκλειστικά από εθελοντές. Τα στοιχεία του οργανισμού είναι:
Expand Down
36 changes: 18 additions & 18 deletions code-of-conduct/gr.md → docs/el/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Κώδικας Δεοντολογίας PyGreece
# Κώδικας Δεοντολογίας

Το PyGreece είναι μια κοινότητα προγραμματιστών που έχει ώς στόχο την δικτύωση και
συνεργασία όλων των κοινοτήτων προγραμματιστών Python στην Ελλάδα.
Expand All @@ -13,23 +13,23 @@
Κάποιες συμπεριφορές που περιγράφουν ένα μέλος της κοινότητας PyGreece είναι:

- Είμαστε πάντα ανοιχτοί σε συνεργασίες. Τα μέλη της κοινότητας θα πρέπει πάντα να είναι
ανοιχτά στη συνεργασία με άλλα μέλη, νέους εθελοντές/προγραμματιστές.
ανοιχτά στη συνεργασία με άλλα μέλη, νέους εθελοντές/προγραμματιστές.
- Επικεντρωνόμαστε στο τι είναι καλύτερο για την κοινότητα.
- Σεβόμαστε τις διαδικασίες που ορίζονται στην κοινότητα και εργαζόμαστε εντός αυτών.
- Αναγνωρίζουμε τον χρόνο και την προσπάθεια. Σεβόμαστε τις εθελοντικές προσπάθειες που
διέπουν την κοινότητα Python. Είμαστε προσεκτικοί όταν αναφερόμαστε στις προσπάθειες των
άλλων.
διέπουν την κοινότητα Python. Είμαστε προσεκτικοί όταν αναφερόμαστε στις προσπάθειες
των άλλων.
- Δείχνουμε ενσυναίσθηση προς τα άλλα μέλη της κοινότητας. Είμαστε προσεκτικοί στην
επικοινωνία μας, είτε αυτοπροσώπως, είτε διαδικτυακά, και είμαστε διακριτικοί όταν
προσεγγίζουμε διαφορετικές απόψεις.
επικοινωνία μας, είτε αυτοπροσώπως, είτε διαδικτυακά, και είμαστε διακριτικοί όταν
προσεγγίζουμε διαφορετικές απόψεις.
- Σεβόμαστε τους άλλους, τις θέσεις τους, τις ικανότητές τους, τις δεσμεύσεις τους και τις
προσπάθειές τους. Είμαστε δεκτικοί σε εποικοδομητικά σχόλια και κριτική, καθώς οι
εμπειρίες και οι δεξιότητες των άλλων μελών συμβάλλουν στο σύνολο των προσπαθειών μας.
προσπάθειές τους. Είμαστε δεκτικοί σε εποικοδομητικά σχόλια και κριτική, καθώς οι
εμπειρίες και οι δεξιότητες των άλλων μελών συμβάλλουν στο σύνολο των προσπαθειών μας.
- Δεχόμαστε με ευγένεια την εποικοδομητική κριτική. Όταν διαφωνούμε, είμαστε ευγενικοί στο
να παρουσιάζουμε τα θέματά μας.
να παρουσιάζουμε τα θέματά μας.
- Χρησιμοποιούμε φιλόξενη και χωρίς αποκλεισμούς γλώσσα. Δεχόμαστε όλους όσους επιθυμούν
να συμμετάσχουν στις δραστηριότητές μας, καλλιεργώντας ένα περιβάλλον όπου ο καθένας
μπορεί να συμμετέχει και όλοι μπορούν να κάνουν τη διαφορά.
να συμμετάσχουν στις δραστηριότητές μας, καλλιεργώντας ένα περιβάλλον όπου ο καθένας
μπορεί να συμμετέχει και όλοι μπορούν να κάνουν τη διαφορά.

## Οι αξίες μας

Expand All @@ -45,23 +45,23 @@
- Παρενόχληση οποιουδήποτε ατόμου με οποιαδήποτε μορφή.
- Εσκεμμένος εκφοβισμός, παρενόχληση ή παρακολούθηση.
- Καταγραφή ή λήψη στιγμιότυπων οθόνης της διαδικτυακής δραστηριότητας για σκοπούς
παρενόχλησης.
παρενόχλησης.
- Δημοσίευση προσωπικών πληροφοριών άλλων, όπως φυσική ή ηλεκτρονική διεύθυνση, χωρίς ρητή
άδεια.
άδεια.
- Βίαιες απειλές ή γλώσσα που στρέφεται κατά άλλου προσώπου.
- Υποκίνηση βίας ή παρενόχλησης προς οποιοδήποτε άτομο, συμπεριλαμβανομένης της
ενθάρρυνσης ενός ατόμου να αυτοκτονήσει ή να αυτοτραυματιστεί.
ενθάρρυνσης ενός ατόμου να αυτοκτονήσει ή να αυτοτραυματιστεί.
- Δημιουργία πρόσθετων διαδικτυακών λογαριασμών με σκοπό την παρενόχληση άλλου ατόμου.
- Γλώσσα και εικόνες στη διαδικτυακή κοινότητα στο discord ή σε οποιονδήποτε χώρο
εκδήλωσης, συμπεριλαμβανομένων των ομιλιών, που σεξουαλικοποιούν, προσβάλλουν,
εξευτελίζουν ή επιτίθενται σε ομάδες ή συγκεκριμένα άτομα.
εκδήλωσης, συμπεριλαμβανομένων των ομιλιών, που σεξουαλικοποιούν, προσβάλλουν,
εξευτελίζουν ή επιτίθενται σε ομάδες ή συγκεκριμένα άτομα.
- Προσβολές, υποτιμήσεις ή αστεία που βασίζονται σε στερεότυπα.
- Ανεπιθύμητη σεξουαλική προσοχή ή προσέγγιση.
- Διαρκής διακοπή των συζητήσεων της διαδικτυακής κοινότητας στο discord, των παρουσιάσεων
ή άλλων εκδηλώσεων.
ή άλλων εκδηλώσεων.
- Συνέχιση της προσωπικής επικοινωνίας μετά από αιτήματα διακοπής αυτής.
- Άλλη συμπεριφορά που είναι ακατάλληλη για ένα επαγγελματικό ακροατήριο που περιλαμβάνει
άτομα με πολλές διαφορετικές καταβολές.
άτομα με πολλές διαφορετικές καταβολές.

Τα μέλη της κοινότητας που καλούνται να σταματήσουν οποιαδήποτε ανάρμοστη συμπεριφορά
αναμένεται να συμμορφωθούν αμέσως.
Expand Down
32 changes: 32 additions & 0 deletions docs/el/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Βάση γνώσεων κοινότητας PyGreece

Συνδέοντας τους λάτρεις της Python στην Ελλάδα - προωθώντας τη συνεργασία, την ενσωμάτωση,
και την ανάπτυξη της κοινότητας.

## Ιστορικό

Καλώς ήρθατε στο website της κοινότητας της PyGreece. Αυτή είναι η βάση γνώσης της
κοινότητας του PyGreece. Πιο αναλυτικά, είναι μια προσπάθεια να μοιραστούμε με τον κόσμο
όλες τις πηγές και τις διαδικασίες που ακολουθούμε.

## Μοιραζόμαστε γνώση και πληροφορίες

Όπως αναφέρθηκε παραπάνω, στόχος μας είναι να μοιραστούμε όλους τους πόρους που έχουμε
μέσα σε αυτό το website. Θα μοιραστούμε λεπτομερείς οδηγίες για το πώς μπορεί κάποιος να
συνεισφέρει στο website σύντομα :)

## Ελληνική μετάφραση της τεκμηρίωσης Python

Ένα από τα κύρια έργα μας είναι η μετάφραση της τεκμηρίωσης της Python στην ελληνική
γλώσσα. Μπορείτε να βρείτε περισσότερες πληροφορίες σχετικά με το έργο
[εδώ](https://github.com/pygreece/python-docs-gr/).

## Εγγραφείτε στον PyGreece Discord Server

Ο PyGreece discord server έχει ως στόχο να συνδέσει όλα τα μέλη της ελληνικής κοινότητας
της Python σε ένα μέρος. Μπορείτε να συμμετέχτε στον server ακολουθώντας
[αυτόν τον σύνδεσμο](https://discord.gg/gWcXmDw8Yj).

## Κώδικας δεοντολογίας του PyGreece

Παρακαλούμε διαβάστε προσεκτικά τον [κώδικα δεοντολογίας μας](code-of-conduct.md)!
Loading

0 comments on commit c554a4b

Please sign in to comment.