From 97802c96ecd01cce4167105d8a35f47a300eabd1 Mon Sep 17 00:00:00 2001 From: asandikci Date: Wed, 30 Aug 2023 23:13:45 +0300 Subject: [PATCH] update docs --- dev/dev-notes/asandikci.md | 1 + dev/environment.md | 57 +++++++++++++++++++++++--------------- dev/newdev.md | 14 +++++++--- 3 files changed, 46 insertions(+), 26 deletions(-) diff --git a/dev/dev-notes/asandikci.md b/dev/dev-notes/asandikci.md index fdec041..06ce2e4 100644 --- a/dev/dev-notes/asandikci.md +++ b/dev/dev-notes/asandikci.md @@ -18,6 +18,7 @@ Yazılım geliştirme konusunda uzman olmadığımdan, go dilini daha önce kull - Modul mantığı ve proje yapısı - Plugin mantığı - Concurrency/goroutine mantığı + - Crosscompile program yazmayı - Linux Daemon - Daemon mantığı (forking) - Iki farklı dilde daemon implementationu diff --git a/dev/environment.md b/dev/environment.md index 4aad164..c37a36f 100644 --- a/dev/environment.md +++ b/dev/environment.md @@ -1,29 +1,42 @@ -## Development Environment - Geliştirici Ortamı +# Development Environment - Geliştirici Ortamı +Bu dosyada geliştirme sürecinin sürekliliği ve bütünlüğü için geliştiricilerin ilk başta kurması gereken ortam anlatılmaktadır. -Geliştirme sürecinin sürekliliği ve bütünlüğü için: -- Önerilen IDE'ler: +--- +## IDE/Eklentiler +### Önerilen IDE'ler - VSCode - VSCodium -- Önerilen VSCode/Codium Eklentileri: - - Comment Anchors (`exodiusstudios.comment-anchors`) - - `TODO` ▶ Future Tasks - - `NEXT` ▶ High Priority Tasks - - settings.json dosyasına ekleyiniz (default, #12449f, file) - - `FILLME` ▶ Reusable code block - - settings.json dosyasına ekleyiniz (default, #A8C993, file) - - `FIXME` ▶ Bug or error - - `NOTE` ▶ Extra note - - `REVIEW` ▶ This code block needs a review - - `LINK` ▶ Link to documentation/forum/information - - Go (`golang.go`) -- Önerilen Makine Düzeni: - - 1 adet Liderahenk sunucusu (Sanal) - - 1 adet Pardus + ahenk-go (Sanal/Fiziksel/Docker) - - 1 adet Windows + ahenk-go (Sanal/Fiziksel) - - 1 adet Debian + ahenk-go (Docker, .deb build için) - - 1 adet Pardus + [ahenk](https://github.com/pardus-liderahenk/ahenk) (python) (Sanal, `opsiyonel`) +### Önerilen VSCode/Codium Eklentileri +#### Comment Anchors (`exodiusstudios.comment-anchors`) + - `TODO` » Future Tasks + - `NEXT` » High Priority Tasks + - settings.json dosyasına ekleyiniz (default, #12449f, file) + - `FILLME` » Reusable code block + - settings.json dosyasına ekleyiniz (default, #A8C993, file) + - `FIXME` » Bug or error + - `NOTE` » Extra note + - `REVIEW` » This code block needs a review + - `LINK` » Link to documentation/forum/information +#### Go (`golang.go`) + - package_linux.go ve package_windows.go kodlarındaki aynı fonksiyonların çakışmaması için gerekli ayarları yapınız. (FIXME) -### Creating Docker Development Environment +--- + +## Önerilen Makine Düzeni +### Geliştirme + - 1 adet Liderahenk sunucusu (Fiziksel/Sanal) + - veya herhangi bir yerel/diğer XMPP sunucusu + - 1 adet GNU/Linux Dağıtımı (Fiziksel/WSL) + - Wine yüklenmiş + - Docker [godeb](#creating-docker-development-environment) + - Paket buildlemek ve mini testler için + - içinde Pardus sanal makine + - Ekstra testler ve [ahenk python implementasyonu](https://github.com/pardus-liderahenk/ahenk)nu anlamak için ahenk yüklenmiş şekilde +### Test + - Pardus sürümleri (Sanal/Fiziksel) + - Windows 10, 11 (Sanal/Fiziksel) + +## Creating Docker Development Environment 1. Install and Create docker environment, [Quick Start](https://sulincix.github.io/sayfalar/html/docker-kullanimi.html) 2. Pull docker image ```sh diff --git a/dev/newdev.md b/dev/newdev.md index 0cf2ac4..e87c6fd 100644 --- a/dev/newdev.md +++ b/dev/newdev.md @@ -41,6 +41,7 @@ Go dili ve ortamın kurulması haricinde bunlar hakkında bilgi sahibi olmanız - Git adresindeki Issue'lerden ilerleyiniz. - Mattermost (veya kullanılan diğer adres)teki roadmap'ten ilerleyiniz. - [Python implementasyonundaki](https://github.com/Pardus-LiderAhenk/ahenk) özelliklerden/pluginlerden devam ediniz. +- [bakınız](#neler-yarım-bırakıldı) ### Genel Taslak - [x] Linux Daemon @@ -52,17 +53,22 @@ Go dili ve ortamın kurulması haricinde bunlar hakkında bilgi sahibi olmanız - [ ] Dynamic Plugin Manager (with unload, reload feature) - [ ] Connection to Lider with XMPP - [ ] Connect with Ahenkdesk -... +- [ ] ... - [ ] plugins/usb -... +- [ ] ... - [ ] plugins/LDAP -... +- [ ] ... - [ ] plugins/... (Look more in [python implementation](https://github.com/Pardus-LiderAhenk/ahenk/tree/master/src/plugins)) -... +- [ ]. .. - [ ] a running Docker Ahenk-go container - [ ] Testing with different operating systems, distributions ... +### Neler Yarım Bırakıldı +- osinfo'yu gopsutil gibi organize etmek, alt dosyalara ayırmak ve windows/linux varyantlarını ayırmak +- resources pluginini daha işlevsel hâle getirmek (python implementasyonundaki tüm işlevlere sahip değil) +- Windows üzerinde çalışan daemon(servis) yapılması, windows için logların, dosyaların ve configlerin ayarlanması +

---