Skip to content

Commit 93d79d1

Browse files
committed
fix: move and aggregate github and git sections
1 parent 8bcf323 commit 93d79d1

10 files changed

Lines changed: 305 additions & 319 deletions

File tree

astro.config.mjs

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,22 @@ export default defineConfig({
8080
label: "Komunikacja",
8181
link: "/communication",
8282
},
83+
],
84+
},
85+
{
86+
label: "Git i GitHub",
87+
items: [
88+
{
89+
label: "Poradnik - czym jest Git?",
90+
autogenerate: { directory: "/git-github/intro", collapsed: true },
91+
},
8392
{
84-
label: "Jak używać githuba?",
85-
link: "/github",
93+
label: "Jak korzystać z Githuba w Solvro?",
94+
link: "/git-github/github",
8695
},
8796
{
88-
label: "Git handbook",
89-
autogenerate: { directory: "git", collapsed: true },
97+
label: "Github Projects - zarządzanie projektami",
98+
link: "/git-github/github-projects",
9099
},
91100
],
92101
},

src/content/docs/git/0-intro.mdx

Lines changed: 0 additions & 39 deletions
This file was deleted.

src/content/docs/github/github-projects.mdx

Lines changed: 254 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ Dzięki publicznemu członkostwu widać Solvro na twoim profilu, a przede wszyst
3636
1. Wejdź na [https://github.com/orgs/Solvro/people](https://github.com/orgs/Solvro/people)
3737
2. Namierz siebie na liście członków i kliknij na swoją aktualną widoczność
3838

39-
![informacja o prywatności członkostwa](../../assets/github/image2.png)
39+
![informacja o prywatności członkostwa](../../../assets/github/image2.png)
4040

4141
3. Wybierz członkostwo publiczne, i tada! Jesteś już pełnoprawnym członkiem naszego koła.
4242

43-
![opcja ustawienia publicznego członkostwa](../../assets/github/image3.png)
43+
![opcja ustawienia publicznego członkostwa](../../../assets/github/image3.png)
4444

4545
### Podaruj nam gwiazdki ⭐⭐⭐
4646

@@ -49,11 +49,11 @@ Zachęcamy do gwiazdkowania naszych publicznych repozytoriów Pokażmy innym, ż
4949
1. Wchodzimy na listę repozytoriów. Ich publiczna liczba będzie tylko rosła (miejmy nadzieję).
5050
2. Wchodzimy po kolei w co fajniejsze projekty.
5151

52-
![losowo wybrany projekt Solvro](../../assets/github/image9.png)
52+
![losowo wybrany projekt Solvro](../../../assets/github/image9.png)
5353

5454
3. Zostawiamy gwiazdkacza ⭐\!
5555

56-
![opcja gwiazdkowania repozytorium](../../assets/github/image5.png)
56+
![opcja gwiazdkowania repozytorium](../../../assets/github/image5.png)
5757

5858
## Nazewnictwo commitów
5959

@@ -151,7 +151,7 @@ Projekty mają wiele zaawansowanych diagramów, z których możecie korzystać w
151151

152152
Podstawowym typem jest jednak tablica KANBAN, gdzie można dodawać zadania w formie draft, lub przypinać issues lub pull-requesty.
153153

154-
![strona projektu](../../assets/github/image8.png)
154+
![strona projektu](../../../assets/github/image8.png)
155155

156156
#### Flow pracy na boardzie
157157

@@ -191,7 +191,7 @@ Jeśli nie rozumiesz technikaliów związanych z którymś z poniższych punktó
191191

192192
Wchodzimy na naszą tablice zadań i przypisujemy się do zadania sygnalizując, że zgłaszamy się do jego zrobienia:
193193

194-
![zgłaszanie się do PR](../../assets/github/image6.png)
194+
![zgłaszanie się do PR](../../../assets/github/image6.png)
195195

196196
### Rozpoczęcie pracy nad zadaniem
197197

@@ -212,13 +212,13 @@ Wchodzimy na naszą tablice zadań i przypisujemy się do zadania sygnalizując
212212
1. Gdy jesteśmy gotowi, zmieniamy status taska na **In Review** (jeśli taki status jest w projekcie).
213213
2. Tworzymy pull requesta z naszego brancha na branch **main** lub **dev** (jeśli aplikacja na main jest już opublikowaną wersją produkcyjną).
214214

215-
![przycisk otwórz PR](../../assets/github/image7.png)
215+
![przycisk otwórz PR](../../../assets/github/image7.png)
216216

217217
3. Dodajemy znaczący tytuł (najlepiej powiązany z nazwą lub numerem taska/tasków) i krótko wypisujemy co zmieniliśmy lub dodaliśmy. Jeśli napotkaliśmy jakiś problem/dylemat, możemy wyjaśnić jak go rozwiązaliśmy, jakiej dokonaliśmy decyzji i dlaczego. Jeśli z jakiegoś powodu nie wykonaliśmy 100% zakresu zadania, to jest to dobre miejsce żeby o tym wspomnieć. Jeśli chcesz ładnie sformatować swój opis, obczaj [tą szybką ściągę do gh markdowna](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
218218
4. Można oznaczyć swojego techleada jako reviewer (opcjonalne).
219219
5. Po prawej na dole, w sekcji _Development_ możesz przypiąć **issue** (np. swoje zadanie), który zostanie automatycznie zamknięty po zmergowaniu tego pull requesta.
220220

221-
![dodawanie issues do PR](../../assets/github/image4.png)
221+
![dodawanie issues do PR](../../../assets/github/image4.png)
222222

223223
6. Oczekujemy na code review od naszego techleada.
224224
7. Przeglądamy komentarze, wprowadzamy sugestie i dyskutujemy nad rzeczami, z którymi się nie zgadzamy. Zadajemy pytania i wprowadzamy zmiany, commitujemy i pushujemy.
@@ -280,5 +280,5 @@ Uwaga: Oprócz README repozytoriów, każdy projekt (kanban board) ma też swoje
280280

281281
To już koniec tego handbooka. Mam nadzieję, że był przydatny i aż tak bardzo nie bolał, mimo zauważalnej liczby stron. Proszę zgłaszać swoje propozycje zmiany tego dokumentu i miłego kodowania 🙂🙃🙂
282282

283-
![Podpis Szymona Kowalińskiego](../../assets/github/image10.png)
283+
![Podpis Szymona Kowalińskiego](../../../assets/github/image10.png)
284284
**Wiceprezes VII Zarządu KN Solvro**

src/content/docs/solvro/Podstawy Gita/intro.mdx renamed to src/content/docs/github/intro/1-intro.mdx

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Podstawy gita i GitHuba
2+
title: 1. Github vs Git
33
description: oto jak elo zelujemy w solvro
44
sidebar:
5-
order: 9
5+
order: 1
66
---
77

88
![Logo git w kolorystyce Solvro](../../../../assets/tutorials/git-basics/solvro-git-logo.png)
@@ -19,7 +19,18 @@ import { Aside } from "@astrojs/starlight/components";
1919
na GitHubie KN Solvro to zajrzyj tutaj: [Jak używać githuba?](/github)
2020
</Aside>
2121

22+
### Inne, przydatne zasoby
23+
24+
- [Oficjalne dokumentacje gita](https://git-scm.com/doc)
25+
- Dostępne są strony manpage dla poszczególnych komend, jak również cała książka poświęcona gitowi, częściowo przetłumaczona na polski.
26+
- linuxiarze zapewne mają wszystkie manpage gita dostepne lokalnie na ich systemach 😎
27+
- [Dokumentacja GitHuba](https://docs.github.com/en/get-started)
28+
- 90% dokumentacji GitHuba zapewnie dotyczy tylko ich serwisu, ale można tam też znaleźć trochę informacji o samym gitcie i jak używać go razem z GitHubem
29+
2230
#### Spis treści
2331

24-
1. [Jak używać gita](/solvro/podstawy-gita/git)
25-
1. [Jak korzystać z GitHuba](/solvro/podstawy-gita/github)
32+
1. [Github vs Git](/git-github/intro/1-intro)
33+
2. [Teoria gita](/git-github/intro/2-git)
34+
3. [Kampania jednoosobowa](/git-github/intro/3-singleplayer)
35+
4. [Współpraca z innymi](/git-github/intro/4-multiplayer)
36+
5. [Jak korzystać z GitHuba (Podstawy)](/git-github/intro/5-github)

src/content/docs/solvro/Podstawy Gita/git.mdx renamed to src/content/docs/github/intro/2-git.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Jak używać gita
2+
title: 2. Teoria gita
33
description: oto jak elo zelujemy w solvro
44
sidebar:
5-
order: 10
5+
order: 2
66
---
77

88
W tym artykule opiszę, po co jest nam git i jak używać jego głównych funkcjonalności.
@@ -72,14 +72,14 @@ Jednakże, jeżeli wszystkie migawki łączyłby liniowy związek, nie możemy
7272

7373
![Przykład z jedną gałęzią w git](../../../../assets/tutorials/git-basics/one-branch-ex.png)
7474

75-
Powyższy diagram pokazuje tworzenie commit'ów na jednej gałęzi.
75+
Powyższy diagram pokazuje tworzenie commit'ów na jednej gałęzi.
7676
Załóżmy, że potrzebujesz przetestować, jak wyglądają dwa różne rozwiązania - głupio byłoby w tym celu kopiować i izolować cały projekt czy usuwać jedne rozwiązanie na rzecz drugiego. Zamiast tego wystarczy utworzyć dwie nowe gałęzie.
7777

7878
### Gałęzie (ang. branches)
7979

8080
![Przykład wielu gałęzi w git](../../../../assets/tutorials/git-basics/multi-branch-ex.png)
8181

82-
Gałęzie pozwalają ci izolować swoją pracę na jednej wersji repozytorium, nie naruszając innych. Możesz na nich prototypować nowe funkcjonalności bez przeszkadzania innym i rozwalania sobie kodu na gałęzi _main_.
82+
Gałęzie pozwalają ci izolować swoją pracę na jednej wersji repozytorium, nie naruszając innych.Możesz na nich prototypować nowe funkcjonalności bez przeszkadzania innym i rozwalania sobie kodu na gałęzi _main_.
8383
Aby utworzyć nową gałąź, używamy komendy:
8484
`git branch {nazwa_gałęzi}`
8585

src/content/docs/git/1-singleplayer.mdx renamed to src/content/docs/github/intro/3-singleplayer.mdx

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Git handbook, rozdział 1: Kampania jednoosobowa"
2+
title: "3. Kampania jednoosobowa"
33
description: "Podstawowe, własne repo z liniową historią"
44
sidebar:
5-
label: "R1: Kampania jednoosobowa"
6-
order: 1
5+
order: 3
76
---
87

98
import AsciinemaPlayer from "#components/AsciinemaPlayer";
@@ -15,15 +14,6 @@ import {
1514
CardGrid,
1615
} from "@astrojs/starlight/components";
1716

18-
## A czym tak właściwie ten git jest?
19-
20-
Git to tzw. system kontroli wersji. (Version Control System, VCS)
21-
22-
Pozwala on na śledzenie, jak pliki w repozytorium zmieniały się na przestrzeni czasu, przez różne wersje, tworzone przez róznych użytkowników.
23-
24-
Ułatwia to współpracę - nie trzeba się bawić z wysyłaniem zipów całego repo, wystarczy zrobić swoje zmiany na swojej gałęzi i/lub forku,
25-
a następnie powiedzieć osobie odpowiedzialnej za głowną gałęź, by pobrała zmiany z twojej gałęzi.
26-
2717
## Nowe repozytorium
2818

2919
By móc korzystać z gita, należy stworzyć lub pobrać jakieś repozytorium.

src/content/docs/git/2-multiplayer.mdx renamed to src/content/docs/github/intro/4-multiplayer.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Git handbook, rozdział 2: Multiplayer sandbox"
2+
title: "4. Współpraca z innymi"
33
description: "Współpraca z innymi, tworzenie i integracja gałęzi"
44
sidebar:
5-
label: "R2: Multiplayer sandbox"
6-
order: 2
5+
order: 4
76
---
87

98
import AsciinemaPlayer from "#components/AsciinemaPlayer";
@@ -55,7 +54,7 @@ Cała zawartość bloku jest hashowana, a sam blok zawiera hashe bloków bezpoś
5554
Jakakolwiek zmiana w zawartości bloku zmienia jego hash w nieprzewidywalny sposób, co jednocześnie unieważnia następujące po nim bloki.
5655
W efekcie **zapisane raz bloki stają się niemodyfikowalne**.
5756

58-
![Git jako blockchain](../../../assets/git/chapter-2/history-01.svg)
57+
![Git jako blockchain](../../../../assets/git/chapter-2/history-01.svg)
5958

6059
Historia w repozytorium jednak nie do końca musi być liniowa.
6160
Historia może się po pewnych zapisach rozgałęziać, a te gałęzie mogą się później ponownie łączyć.

src/content/docs/solvro/Podstawy Gita/github.mdx renamed to src/content/docs/github/intro/5-github.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Jak korzystać z GitHuba
2+
title: 5. Jak korzystać z GitHuba (Podstawy)
33
description: oto jak elo zelujemy w solvro
44
sidebar:
5-
order: 11
5+
order: 5
66
---
77

88
W tym wpisie zajmiemy się GitHubem. Zakładam, że umiesz już używać gita w lokalnym środowisku.
@@ -152,12 +152,12 @@ Poniżej tych pól wyświetlą nam się do podglądu zmiany w kodzie.
152152

153153
![Pull request edit window](../../../../assets/tutorials/git-basics/pull-request-1.png)
154154

155-
Może zdarzyć się tak, że przy dodawaniu PR pojawią się konflikty. Możemy znów sfetchować repo do siebie i naprawić je lokalnie, po czym wysłać z powrotem na upstream,
155+
Może zdarzyć się tak, że przy dodawaniu PR pojawią się konflikty.Możemy znów sfetchować repo do siebie i naprawić je lokalnie, po czym wysłać z powrotem na upstream,
156156
ale do mniejszych PR w pełni wystarczający jest webowy edytor tekstowy GitHuba.
157157

158158
![Conflicts in github editor](../../../../assets/tutorials/git-basics/pull-request-2.png)
159159

160-
Kiedy już rozwiążemy konflikty, pojawi się nam opcja scalania gałęzi. Możemy tu wybrać metodę scalania (zwykłe, squash, rebase). Wystarczy zaznaczyć tę, która najbardziej
160+
Kiedy już rozwiążemy konflikty, pojawi się nam opcja scalania gałęzi.Możemy tu wybrać metodę scalania (zwykłe, squash, rebase). Wystarczy zaznaczyć tę, która najbardziej
161161
nam pasuje i już. Gotowe! Zmerge'owaliśmy nasze zmiany do main. Jeżeli jesteśmy pewni, że wszystko działa tak, jak powinno - a na tym etapie powinniśmy być - to możemy usunąć zbędną gałąź.
162162

163163
_Reminder: Nie zawsze mamy uprawnienia do samodzielnego dodawania zmian na main i merge'ować musi np. nasz tech-lead._

0 commit comments

Comments
 (0)