search

mpfmorawski / git-to-know-me

3 stars 1 forks source link

Rozwijanie dokumentacji #11

Closed mpfmorawski closed 2 years ago

mpfmorawski commented 2 years ago

Jest to issue do informowania, co zostało opracowane i można to dodać do dokumentacji

mpfmorawski commented 2 years ago
mpfmorawski commented 2 years ago

Poprawiłem dokumentację o ogólne formatowanie, zmodyfikowałem pierwotne założenia na temat funkcjonalności tak, aby dopasować je do najnowszego planu względem aplikacji oraz dodałem rozdziały Architektura aplikacji i Projekt interfejsu graficznego.

Bardzo proszę o informację, co dodać/poprawić/usunąć w rozdziałach:

Plik z aktualną dokumentacją: DOKUMENTACJA - 15.04.2022

kamilwil commented 2 years ago

@mpfmorawski Ostatecznie ustaliliśmy, że rejestracji u nas jako takiej nie będzie, a przyciski do logowania będą elementem widoku dla niezalogowanego użytkownika. Więc właściwie będziemy mieli dwa widoki (1 i 3 wg aktualnej numeracji w pliku).

Przy okazji, podsyłam logo w większej rozdzielczości, które można wstawić do strony tytułowej.

![git-to-know-me_logo_3t_tall](https://user-images.githubusercontent.com/36759202/163622454-75e5da72-8b5c-41c2-9992-7ece257b91f0.png)
pktiuk commented 2 years ago

Jak coś to moim zdaniem dokumentacja jest git, chociaż szczerze mówiąc nie jestem pewien, czy jest potrzeba wypisywać prowadzącemu endpointy.

mpfmorawski commented 2 years ago

Zaktualizowałem dokumentację na podstawie uwag @kamilwil.

Jednocześnie dziękuję @pktiuk za zatwierdzenie. Endpointy chciałbym zostawić w dokumentacji ze względu na naszą współpracę wewnątrz zespołu. Każdy będzie mógł do tej dokumentacji zerknąć, żeby je sprawdzić.

Plik z aktualną dokumentacją: DOKUMENTACJA - 20.04.2022

pktiuk commented 2 years ago

Z mojej strony nie mam nic do dodania w kontekście dokumentacji.
Jeśli w jakiś szczególny sposób rozwinę routing wewnątrz aplikacji to będzie można opisać ten aspekt.

KarolNiem commented 2 years ago

Z małych uwag to w nazwie 4 rozdziału jest błąd. Powinno być ,,projekt interfejsu graficznego''. A tak poza tym to merytorycznie wydaje się być ok.

jprokopczuk commented 2 years ago

Na obecną chwilę zminił się endpoint fetchera z /github/stats/general_user/ na /github/stats/{user_name}.

mpfmorawski commented 2 years ago

Zaktualizowałem dokumentację na podstawie uwag @KarolNiem oraz @jprokopczuk.

Jednocześnie jest to też dokumentacja, którą wysyłałem do dr Kruka (ze względu na wiadomość z informacjami organizacyjnymi z 20.04.2022): "Concept of your project solution (including architecture, in formal notation or without but still communicative - choice is up to you) I expect to be ready for me for the next Thursday (28.04) - team leader should send me this day it as a single pdf file via email."

Plik z aktualną dokumentacją: DOKUMENTACJA - 28.04.2022

mpfmorawski commented 2 years ago

Notatka ze spotkania 06.05.2022:

Ewentualnie można wspomnieć o routingu w postaci akapitu w tekście

lapankrz commented 2 years ago

Dodanie info o konfiguracji Nginx - nasłuchiwanie na porcie 8000 requestów od użytkownika, komunikacja międzyserwisowowa na portach 8001-8004 (dokładniej opisane w folderze common np. na branchu multiproc)

pktiuk commented 2 years ago

Możesz dopisać w dokumentacji akapit poświęcony bezpieczeństwu.
Można tu podkreślić takie aspekty jak:

Tak btw to robiąć deployment przez CF możemy też monitorować pewne aspekty ruchu naszej strony image

mpfmorawski commented 2 years ago

Uzupełniłem dokumentację na podstawie sugestii.

Plik z aktualną dokumentacją: DOKUMENTACJA - 31.05.2022

Kolejne aktualizacje dokumentacji będą umieszczane w #32