refactor: add lint, http-serve, preview, http-preview make commands

Author: gmargaritis

CONTRIBUTING.md

@@ -14,11 +14,16 @@ Eυχαριστούμε πολύ για το ενδιαφέρον σας να σ
 
 ## Περιεχόμενα
 
-1. [Προετοιμασία](#προετοιμασία)
-2. [Συνεισφορά](#συνεισφορά)
-    1. [Μετάφραση Αρχείου](#μετάφραση-αρχείου)
-    2. [Αξιολόγηση Μετάφρασης](#αξιολόγηση-μετάφρασης)
-3. [Λερώστε τα χέρια σας! Μεταφράστε!](#λερώστε-τα-χέρια-σας-μεταφράστε)
+- [Οδηγός συνεισφοράς στο πρότζεκτ Python-Docs-Gr της κοινότητας PyGreece](#οδηγός-συνεισφοράς-στο-πρότζεκτ-python-docs-gr-της-κοινότητας-pygreece)
+  - [Περιεχόμενα](#περιεχόμενα)
+    - [Προετοιμασία](#προετοιμασία)
+    - [Συνεισφορά](#συνεισφορά)
+    - [Μετάφραση Αρχείου](#μετάφραση-αρχείου)
+    - [Αξιολόγηση Μετάφρασης](#αξιολόγηση-μετάφρασης)
+    - [Λερώστε τα χέρια σας! Μεταφράστε!](#λερώστε-τα-χέρια-σας-μεταφράστε)
+    - [🎉🎉ΤΕΛΟΣ🎉🎉](#τελος)
+  - [Προεπισκόπηση αλλαγών](#προεπισκόπηση-αλλαγών)
+  - [Γενικές Οδηγίες](#γενικές-οδηγίες)
 
 ### Προετοιμασία
 
@@ -31,7 +36,7 @@ Eυχαριστούμε πολύ για το ενδιαφέρον σας να σ
 2. Κάντε clone το repository που μόλις δημιουργήσατε:
 
 ```bash
-git clone git@github.com:<το username σας>/python-docs-gr.git
+git clone --recursive git@github.com:<το username σας>/python-docs-gr.git
 ```
 
 3. Μεταβείτε στον φάκελο που δημιουργήθηκε:
@@ -120,13 +125,13 @@ To milestone που μπορείτε να συνεισφέρετε είναι τ
 
 Τα εργαλεία που προτείνουμε να χρησιμοποιήσετε είναι το [VScode](https://code.visualstudio.com/) ή το [PoEdit](https://poedit.net/). Για το [VScode](https://code.visualstudio.com/) μια χρήσιμη επέκταση είναι το [`gettext` extension](https://marketplace.visualstudio.com/items?itemName=mrorz.language-gettext). Αντίθετα το [PoEdit](https://poedit.net/) χρησιμοποιεί ένα καλύτερο περιβάλλον διεπαφής και δεν απατείται να ασχοληθεί ο χρήστης με τη δομή του αρχείου.
 
-2. Επιβεβαιώστε ότι είστε στο 3.12 branch (πολύ σημαντικό βήμα για να αποφύγετε να ξεκινήσετε ένα branch από παλαιότερη έκδοση):
+1. Επιβεβαιώστε ότι είστε στο 3.12 branch (πολύ σημαντικό βήμα για να αποφύγετε να ξεκινήσετε ένα branch από παλαιότερη έκδοση):
 
 ```bash
 git checkout 3.12
 ```
 
-3. Δημιουργείστε ένα branch βασισμένο στο αρχείο που θα δουλέψετε. Για παράδειγμα, εάν δουλέυετε στο αρχείο library/ast.po το όνομα του branch θα μπορούσε να είναι:
+2. Δημιουργείστε ένα branch βασισμένο στο αρχείο που θα δουλέψετε. Για παράδειγμα, εάν δουλέυετε στο αρχείο library/ast.po το όνομα του branch θα μπορούσε να είναι:
 
 ```bash
 git checkout -b translate-library-ast
@@ -140,53 +145,30 @@ git checkout -b library-set
 git checkout -b ft/library-set
 ```
 
-4.  Αφού έχετε διαλέξει το αρχείο σας, ξεκινήστε την μετάφραση στο IDE της επιλογής σας. Επίσης μπορείτε να χρησιμοποιήσετε εργαλεία για την σωστή μετάφραση προτάσεων, φράσεων ή λέξεων.
+3.  Αφού έχετε διαλέξει το αρχείο σας, ξεκινήστε την μετάφραση στο IDE της επιλογής σας. Επίσης μπορείτε να χρησιμοποιήσετε εργαλεία για την σωστή μετάφραση προτάσεων, φράσεων ή λέξεων.
 
-5.  Εφόσον έχετε ολοκληρώσει τη μετάφρασή σας είναι απαραίτητο να χρησιμοποιήσετε τις εντολές που αναφέρονται παρακάτω προκειμένου να γίνει μορφοποίηση του αρχείου για να έχει μια σωστή δομή καθώς και να γίνει ορθογραφικός έλεγχος.
+4.  Εφόσον έχετε ολοκληρώσει τη μετάφρασή σας είναι απαραίτητο να χρησιμοποιήσετε τη παρακάτω εντολή προκειμένου να γίνει μορφοποίηση του αρχείου για να έχει μια σωστή δομή καθώς και να γίνει ορθογραφικός έλεγχος.
 
-    1. `powrap`: έλεγχος και μορφοποίηση της δομής του αρχείου. Μπορείτε να χρησιμοποιήσετε το ακόλουθο script.
 
-        ```bash
-        powrap <φάκελος>/<όνομα_του_αρχείου>.po
-        ```
-
-        Εάν είστε χρήστης των windows μπορείτε να δείτε περισσότερες πληροφορίες [εδώ](https://python-docs-es.readthedocs.io/es/3.12/faq.html#powrap-windows).
-
-    2. `popspell`: ορθογραφικός έλεγχος του αρχείου [pospell](https://github.com/AFPy/pospell). Μπορείτε να χρησιμοποιήσετε το ακόλουθο script.
-
-        ```bash
-        python scripts/check_spelling.py <φάκελος>/<όνομα_του_αρχείου>.po
-        ```
-
-        Εάν κάποια από τις λέξεις δεν είναι αναγνωρισμένη από το script προσθέστε την στο [dictionary](/dictionaries/main.txt) και επαναλάβετε.
-
-    3. `pre-commit`: ετοιμάζει και κάνει τις απαραίτητες διαδικασίες προκειμένου το αρχείο να περάσει επιτυχώς τους ελέγχους για την προσάρτισή του. Μπορείτε να χρησιμοποιήσετε το ακόλουθο script.
-
-        ```bash
-        pre-commit run --all-files
-        ```
-
-        Πιο αναλυτικά το παραπάνω script κάνει:
-
-        - τη διαδικασία του `powrap`
-        - ορθογραφικό έλεγχο
-        - μορφοποίηση του λεξικού (Αλφαβητική ταξινόμηση και αφαίρεση διπλότυπων)
+```bash
+make lint
+```
 
-6.  Μετά από την ολοκλήρωση της μετάφρασης μην ξεχάσετε να βάλετε τα στοιχεία σας στο:
+5.  Μετά από την ολοκλήρωση της μετάφρασης μην ξεχάσετε να βάλετε τα στοιχεία σας στο:
 
 ![metadata](/public/assets/metadata-po.png)
 
 Στο **Language-Team** metadata γράφετε: `"Language-Team: PyGreece <pygreece@gmail.com>\n"`
 
-7. Όταν ολοκληρώσετε την μετάφραση σας, πρέπει να αποθηκεύσετε τις αλλαγές σας και να κάνετε push στο GitHub (Μην ξεχάσετε να προσθέσετε το όνομά σας στο αρχείο `TRANSLATORS`). Για παράδειγμα εάν εργαζόσασταν στο αρχείο `library/ast.po` τα βήματα θα ήταν:
+6. Όταν ολοκληρώσετε την μετάφραση σας, πρέπει να αποθηκεύσετε τις αλλαγές σας και να κάνετε push στο GitHub (Μην ξεχάσετε να προσθέσετε το όνομά σας στο αρχείο `TRANSLATORS`). Για παράδειγμα εάν εργαζόσασταν στο αρχείο `library/ast.po` τα βήματα θα ήταν:
 
 ```bash
 git add library/ast.po
 git commit -m 'Translate file library/ast.po'
 git push origin translate-library-ast
 ```
 
-8. Έπειτα μπορείτε να ανοίξετε ένα Pull Request προκειμένου να εξεταστεί/ελεγχθεί η συνεισφορά σας, να γίνουν κάποια σχόλια και εν τέλει να προσαρτηθεί στο βασικό repository. Εφόσον έχετε κάνει push το branch σας θα δείτε κάτι όπως παρακάτω:
+7. Έπειτα μπορείτε να ανοίξετε ένα Pull Request προκειμένου να εξεταστεί/ελεγχθεί η συνεισφορά σας, να γίνουν κάποια σχόλια και εν τέλει να προσαρτηθεί στο βασικό repository. Εφόσον έχετε κάνει push το branch σας θα δείτε κάτι όπως παρακάτω:
 
 ![pr](/public/assets/pr.png)
 
@@ -202,6 +184,22 @@ git push origin translate-library-ast
 
 Συγχαρητήρια, συνεισφέρατε στο έργο και πλέον είστε μέλος του μεγάλου εγχειρήματος της μετάφρασης.
 
+## Προεπισκόπηση αλλαγών
+
+Αν θέλετε να κάνετε προεπισκόπηση των αλλαγών που κάνατε μπορείτε να χρησιμοποιήσετε τις παρακάτω εντολές:
+
+```bash
+make preview
+```
+
+ή
+
+```bash
+make http-preview
+```
+
+Στη τελευταία περίπτωση, με την ολοκλήρωση της εντολής, επισκευφτείτε τη διεύθυνση http://localhost:8000/ στον browser σας.
+
 ## Γενικές Οδηγίες
 
 -   Σε πολλές περιπτώσεις το καλύτερο κριτήριο είναι να σκεφτούμε το λεξιλόγιο που χρησιμοποιούμε όταν εξηγούμε σε άλλο άτομο ή στη δουλειά. Σε πολλές περιπτώσεις, η αγγλική είναι πολύ καλύτερη αν θελετε πχ. να πείτε "git join".

Makefile

@@ -70,7 +70,7 @@ all: ensure_prerequisites
 	  -D latex_elements.inputenc=       \
 	  -D latex_elements.fontenc='       \
 	  $(MODE)
-	@echo "Build success, open file://$(abspath $(CPYTHON_PATH))/Doc/build/html/index.html or run 'make serve' to see them."
+	@echo "Build success, open file://$(abspath $(CPYTHON_PATH))/Doc/build/html/index.html or run either 'make http-serve' or 'make serve' to see them."
 
 
 .PHONY: ensure_prerequisites
@@ -102,13 +102,32 @@ ensure_prerequisites:
 serve:
 	$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('cpython/Doc/build/html/index.html'))"
 
+.PHONY: http-serve
+http-serve:
+	$(PYTHON) -m http.server -d cpython/Doc/build/html/
+
+.PHONY: preview
+preview:
+	make all && make serve
+
+.PHONY: http-preview
+http-preview:
+	make all && make http-serve
 
 .PHONY: progress
 progress:
 	@$(PYTHON) -c 'import sys; print("{:.1%}".format(int(sys.argv[1]) / int(sys.argv[2])))'  \
 	$(shell msgcat *.po */*.po | msgattrib --translated | grep -c '^msgid') \
 	$(shell msgcat *.po */*.po | grep -c '^msgid')
 
+.PHONY: spellcheck
+spellcheck:
+	$(PYTHON) scripts/check_spelling.py $(filter-out $@, $(MAKECMDGOALS))
+
+.PHONY: lint
+lint:
+	powrap *.po **/*.po && \
+	make spellcheck
 
 .PHONY: todo
 todo: ensure_prerequisites