Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: move handbooks to sections #32

Merged
merged 4 commits into from
Jan 14, 2025
Merged

refactor: move handbooks to sections #32

merged 4 commits into from
Jan 14, 2025

Conversation

dawidlinek
Copy link
Member

Proponuję zmianę struktury docs i wydzielenie 4 głównych sekcji:

  • Start here - tak jak jest obecnie najważniejsze rzeczy dot. dokumentacji i jej pisania. Można jeszcze zrobić roadmapę nowego człoka
  • Solvro - rzeczy wysoko organizacyjne, takie jak strategia, poszczególne zarządy, sprawozdania itd.
  • Sekcje - każda sekcja będzie miała swój folder za który będzie odpowiedzialny przewodniczący sekcji. W folderach będą hadnbooki, szkolenia, solvro talki, coś o sekcji itd.
  • Projekty - projekty mogą dodać swój folder w którym mogą mieć historię projektu, dokumentację itd. Za folder projektu jest odpowiedzialny przewodniczący projektu.

@dawidlinek dawidlinek self-assigned this Jan 10, 2025
@dawidlinek dawidlinek added the enhancement New feature or request label Jan 10, 2025
Copy link
Member

@simon-the-shark simon-the-shark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nie jestem przekonany że poradnik Github powinien być w management bo żaden programistycznie myślący programista tam nie zajrzy i jeszcze mniej osób będzie wiedzieć jak nazywać commity. Szczególnie że Konrad gotuje advanced githubowy jakiś więc też musisz na to przewidzieć miejsce.

poza tym chyba ok, ale to approve @Rei-x moim zdaniem potrzebny tutaj głównie

Copy link
Member

@Rei-x Rei-x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imo github i communication channels powinno być w sekcji Solvro NAD strategią, zarządem i struktura - to są rzeczy nieprzydatne i nieczytelne dla członków, powinny być w sekcji typu "Dla zarządu". Poza tym to zmiana na lepsze. Sekcja start here też jest dobrym kandydatem

powtórzę się, bo to ważne - proszę Cie Dawid, zacznij patrzeć na solvro z perspektywy CZŁONKA, a nie prezesa zarządu i zacznij pod to optymalizować

README.md Outdated Show resolved Hide resolved
Copy link
Member

@wkrzos wkrzos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Odnośnie poradnika GitHub: są tam elementy głównie dla deweloperów, to też można go z management przenieść. do sekcji Start Here. Są to jednak podstawy. Warto pamiętać też, że docelowo chcemy przenieść na GitHub projects osoby o zdolnościach miękkich. To będzie wymagało poradnika GitHub do samych projektów (żeby nikt się nie przestraszył commitów, branchy, itd.

Odnośnie odbiorców dokumentacji: też jestem za przeniesieniem Solvro niżej. Te ustalenia są przydatne i kluczowe, ale dla osób o większej odpowiedzialności w kole (których jest 16 na 102 członków). To też większość członków potrzebuje całej reszty dokumentacji bardziej.

Ogólnie podział na więcej sekcji mocno na plus. Osobiście podoba mi się podział na sekcje. Trochę ewentualnie martwi mnie aktywność wszystkich sekcji (np. osoby z social mogą nie uznać tej dokumentacji za praktyczną do swoich potrzeb). Również, nie widzę ML, UI/UX.

Co do poradnika Communication Channels: tutaj problem podobny co do GitHub, to dosyć elementarna wiedza, która przydatna jest większości członków. Może przeniesiemy to również do Start here? Tak, to dotyczy strikte zarządzania, ale tam może być to wygodniejsze.

Posłużyłbym się Start here jako sekcją na crash course dla członków. Wszystkie te ogólno-dotyczące kwestie. Co sądzicie?

@simon-the-shark
Copy link
Member

simon-the-shark commented Jan 11, 2025

Odnośnie poradnika GitHub: są tam elementy głównie dla deweloperów, to też można go z management przenieść. do sekcji Start Here. Są to jednak podstawy. Warto pamiętać też, że docelowo chcemy przenieść na GitHub projects osoby o zdolnościach miękkich. To będzie wymagało poradnika GitHub do samych projektów (żeby nikt się nie przestraszył commitów, branchy, itd.

Odnośnie odbiorców dokumentacji: też jestem za przeniesieniem Solvro niżej. Te ustalenia są przydatne i kluczowe, ale dla osób o większej odpowiedzialności w kole (których jest 16 na 102 członków). To też większość członków potrzebuje całej reszty dokumentacji bardziej.

Ogólnie podział na więcej sekcji mocno na plus. Osobiście podoba mi się podział na sekcje. Trochę ewentualnie martwi mnie aktywność wszystkich sekcji (np. osoby z social mogą nie uznać tej dokumentacji za praktyczną do swoich potrzeb). Również, nie widzę ML, UI/UX.

Co do poradnika Communication Channels: tutaj problem podobny co do GitHub, to dosyć elementarna wiedza, która przydatna jest większości członków. Może przeniesiemy to również do Start here? Tak, to dotyczy strikte zarządzania, ale tam może być to wygodniejsze.

Posłużyłbym się Start here jako sekcją na crash course dla członków. Wszystkie te ogólno-dotyczące kwestie. Co sądzicie?

No generalnie plus jeden wojciu

@wkrzos wkrzos mentioned this pull request Jan 11, 2025
@dawidlinek
Copy link
Member Author

Odnośnie poradnika GitHub: są tam elementy głównie dla deweloperów, to też można go z management przenieść. do sekcji Start Here. Są to jednak podstawy. Warto pamiętać też, że docelowo chcemy przenieść na GitHub projects osoby o zdolnościach miękkich. To będzie wymagało poradnika GitHub do samych projektów (żeby nikt się nie przestraszył commitów, branchy, itd.

Odnośnie odbiorców dokumentacji: też jestem za przeniesieniem Solvro niżej. Te ustalenia są przydatne i kluczowe, ale dla osób o większej odpowiedzialności w kole (których jest 16 na 102 członków). To też większość członków potrzebuje całej reszty dokumentacji bardziej.

Ogólnie podział na więcej sekcji mocno na plus. Osobiście podoba mi się podział na sekcje. Trochę ewentualnie martwi mnie aktywność wszystkich sekcji (np. osoby z social mogą nie uznać tej dokumentacji za praktyczną do swoich potrzeb). Również, nie widzę ML, UI/UX.

Co do poradnika Communication Channels: tutaj problem podobny co do GitHub, to dosyć elementarna wiedza, która przydatna jest większości członków. Może przeniesiemy to również do Start here? Tak, to dotyczy strikte zarządzania, ale tam może być to wygodniejsze.

Posłużyłbym się Start here jako sekcją na crash course dla członków. Wszystkie te ogólno-dotyczące kwestie. Co sądzicie?

+2 Wojciu. Github i Communication Channels przeniosłem do Start Here.

Sekcji, które nie mają contentu nie dodawałem na siłę, żeby nie tworzyć pustych katalogów, jak się coś pojawi to sobie dodadzą folder. Jak praktyczne będzie to dla innych sekcji to zobaczymy z czasem.

Jedynie nie zgadzam się z przeniesieniem Solvro niżej, pamiętajmy, że dokumentacja jest nie tylko dla członków koła, ale również dla osób z zewnątrz, które chcą poznać bardziej naszą organizację. Np. linkiem do strategii już chyba posłużyłem się 4 razy w ostatnie kilka dni. Nie wiem też czy to kwestia docsa czy konfiguracji, ale domyślnie mi się wszystkie zakładki automatycznie otwierają, Solvro ma tylko 3 podstrony i dużo więcej na razie nie planuję tam dodawać (może timeline jeszcze). W sekcjach i projektach tych rzeczy będzie dużo, więc jeśli przeniesiemy Solvro na sam dół to nie będzie go widać wcale. Niezależnie od odpowiedzialności strategia i plany na obecny rok powinny być ważne dla każdego, więc też mam nadzieję, że będąc wyżej więcej osób tam zajrzy.

@Rei-x Rei-x merged commit f601943 into main Jan 14, 2025
1 check passed
@Rei-x Rei-x deleted the feat/change-structure branch January 14, 2025 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants