Kihagyás

Üdvözlünk a Gránit Guru projekt dokumentációján!

Ezen dokumentáció célja, hogy összefoglalja a projekt teljes tudásbázisát, konvencióit, jótanácsait. Törekszünk arra, hogy a wiki alapvetően friss, pontos, és a munkafolyamataink legtöbb részére kiterjedő maradjon.

Ha új vagy a projekten

Ha új vagy a projekten, ajánlott az Onboarding oldalon kezdened!

Fontosabb linkek és források 🔗

A wiki struktúrája

A wiki célja kettős. Egyrészt a Gránit Guru működését írja le mind koncepcionális, mind technikai oldalról. Ebben koncepcionálisan a Diagram és Koncepciók, míg technikailag mélyebben a Modulok szekciók állnak rendelkezésünkre.

Másrészt feladat az is, hogy definiálja és támogassa a tervezői és fejlesztői eszköztárat a egy fejlesztés ötletének megszületéséről egészen annak élesítéséig, a folyamat minden egyes lépésében. Ide tartoznak a JIRA, Fejlesztés, DevOps, Release, és Git szekciók.

Az egyes szekciók részletes leírását megtaláljuk a hozzájuk tartozó Áttekintés részben.

Jelölések

A wikin általánosságban az alábbi vizuális jelölésrendszert alkalmazzuk. Ettől adott szócikk eltérhet, ekkor ez vagy meg van említve, vagy nyilvánvaló a blokk tartalmából és a kontextusból.

Álalános good-to-know információ

Ez itt egy olyan információ, amit jó ha tud adott témában az ember, de nem feltétlen szerves tudás az adott szócikk funkciója szempontjából.

Tipp

Tipp jellegű információ, azaz nem szükséges része az adott szócikknek, ugyanakkor gyakorlati tapasztalat alapján hasznos gyakorlati kiegészítése.

Általános megjegyzés

Teljes mértékben kiegészítő információ, néha mit-miért-hogyan kérdésekre ad választ.

Fontos megjegyzés

A szócikk felületes megértése szempontjából nem, ugyanakkor a témában való elmélyülés tekintetében elengedhetetlen információ.

Példa

Példák adott eset bemutatására.

Figyelmeztetés

Gyakori pitfall-ok, instrukció az környező információ helyes kezelésére.

Kiemelt figyelmeztetés

Ezt mindenképp szükséges elolvasni, figyelemfelhívás szempontjából van kiemelve.

Python-ra vonatkozó információ

Olyan információ, ami kifejezetten Python-ban való fejlesztésre vonatkozik.

Feladat

Egy feladat leírása, általában Adott+Feladat formátumban.

Algoritmus

Egy algoritmus működése.

Hibák, visszajelzések

Előfordulhat, hogy adott információ annyira friss hogy még nem került megfelelően dokumentálásra, vagy esetleg egy módosítás nem lett minden megjelenésénél átírva. Mindenesetre akár ilyen, akár egyéb visszajelzést szívesen fogadunk, és igyekszünk minél gyorsabban korrigálni, bővíteni a megfelelő részeket.

Az midenkori hiba- és visszajelzés-követő táblázat itt található!