Docs cleanup

zgoda · Mar 15, 2023 · 4812c11 · 4812c11
1 parent 0c2eef6
commit 4812c11
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/docs/bipadmin.rst b/docs/bipadmin.rst
@@ -10,7 +10,7 @@ Zakładanie konta pierwszego administratora
 
 W aplikacjach z zarządzeniem kontami użytkowników występuje problem zbliżony do paradoksu *jajka i kury* - do zakładania kont użytkowników potrzebne jest konto użytkownika administracyjnego, które jakoś musi zostać założone, pomimo braku jakiegokolwiek konta w systemie. W aplikacji BIP jest to rozwiązane tak, że konto pierwszego administratora jest zakładane przy użyciu wiersza poleceń aplikacji.
 
-Aby założyć konto użytkownika należy zalogować się do powłoki (*shell*) serwera na którym jest zainstalowana aplikacja, a następnie po aktywowaniu wirtualnego środowiska uruchomieniowego Pythona uruchomić program bip:
+Aby założyć konto użytkownika należy zalogować się do powłoki (*shell*) serwera na którym jest zainstalowana aplikacja, a następnie po aktywowaniu wirtualnego środowiska uruchomieniowego Pythona uruchomić program bip:
 
 .. code-block:: shell-session
 
@@ -57,7 +57,7 @@ Z powyższego opisu polecenia wynika, że do utworzenia konta konieczne jest pod
 
     $ bip user create --name nazwakonta --password haslo --active --admin
 
-Parametry ``name`` i ``password`` mają również formę skróconą:
+Parametry ``name`` i ``password`` mają również formę skróconą:
 
 .. code-block:: shell-session
 

diff --git a/docs/devguide.rst b/docs/devguide.rst
@@ -43,6 +43,7 @@ W tym momencie kod powinien już być uruchamialny, ale wcześniej dobrze będzi
 .. code-block:: shell
 
     export FLASK_DEBUG="1"
+    export FLASK_TESTING="0"
     export SITE_JSON="${PWD}/conf/site.json"
     export DB_NAME="${PWD}/db.sqlite3"
     export SECRET_KEY="losowe znaki"

diff --git a/docs/install.rst b/docs/install.rst
@@ -49,7 +49,7 @@ Oprogramowanie opcjonalne
 
 * serwer bazy danych (PostgreSQL lub MySQL)
 
-Jeszcze słówko na temat przechowywania danych przez aplikację. Decyzję o tym, czy używać bazy serwerowej jak PostgreSQL czy MySQL proszę podjąć po dokonaniu oceny zarówno docelowej wielkości serwisu, jak i tego jak będzie on obsługiwany od strony edytorskiej. W sytuacji gdy serwis będzie miał jednego lub dwóch edytorów, którzy dodatkowo rzadko będą prowadzić edycję zawartości jednocześnie, a ilość stron nie przekroczy 1000, serwerowa baza danych będzie wytaczaniem armaty na muchy. W tej sytuacji zupełnie dobrze poradzi sobie wbudowana baza SQLite, która ma ten wielki plus, że jest całkowicie bezobsługowa. Właściwie jedynym przypadkiem kiedy **konieczne** będzie użycie bazy serwerowej będzie przypadek uruchamiania aplikacji w kilku instancjach działających na oddzielnych maszynach (fizycznych lub wirtualnych).
+Jeszcze słówko na temat przechowywania danych przez aplikację. Decyzję o tym, czy używać bazy serwerowej jak PostgreSQL czy MySQL proszę podjąć po dokonaniu oceny zarówno docelowej wielkości serwisu, jak i tego jak będzie on obsługiwany od strony edytorskiej. W sytuacji gdy serwis będzie miał jednego lub dwóch edytorów, którzy dodatkowo rzadko będą prowadzić edycję zawartości jednocześnie, a ilość stron nie przekroczy 1000, serwerowa baza danych będzie wytaczaniem armaty na muchy. W tej sytuacji zupełnie dobrze poradzi sobie wbudowana baza SQLite, która ma ten wielki plus, że jest całkowicie bezobsługowa. Właściwie jedynym przypadkiem kiedy **konieczne** będzie użycie bazy serwerowej będzie przypadek uruchamiania aplikacji w kilku instancjach działających na oddzielnych maszynach (fizycznych lub wirtualnych).
 
 Instalacja aplikacji krok po kroku
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -96,7 +96,7 @@ Po zakończeniu instalacji utwórz w katalogu aplikacji łącze symboliczne do k
 
     $ ln -s venv/lib/python3.7/site-packages/bip/static static
 
-Innym rodzajem zawartości serwisu są pliki udostępnione do pobrania. Aplikacja umieszcza je we wskazanym miejscu i je również dobrze będzie trzymać tam gdzie i całą resztę. Ścieżka do tego katalogu jest później przekazana w zmiennej środowiskowej.
+Innym rodzajem zawartości serwisu są pliki udostępnione do pobrania. Aplikacja umieszcza je we wskazanym miejscu i je również dobrze będzie trzymać tam gdzie i całą resztę. Ścieżka do tego katalogu jest później przekazana w zmiennej środowiskowej.
 
 .. code-block:: shell-session
 
@@ -130,6 +130,7 @@ Każdy z poniższych przykładów ładuje część ustawień ze zmiennych środo
 .. code-block:: shell
 
     FLASK_DEBUG="0"
+    FLASK_TESTING="0"
     INSTANCE_PATH="/home/mojekonto/bip/instance"
     SITE_JSON="/home/mojekonto/bip/conf/site.json"
     DB_NAME="/home/mojekonto/bip/db.sqlite3"

diff --git a/docs/userguide.rst b/docs/userguide.rst
@@ -14,7 +14,7 @@ Odnośnik ten prowadzi do strony logowania, na której trzeba podać nazwę uży
 
 .. image:: /_static/login_page.png
 
-Po podaniu prawidłowych danych użytkownik zostanie przeniesiony z powrotem do ostatnio otwartej strony, a u góry strony pojawi się winieta informująca o pomyślnym logowaniu.
+Po podaniu prawidłowych danych użytkownik zostanie przeniesiony z powrotem do ostatnio otwartej strony, a u góry strony pojawi się winieta informująca o pomyślnym logowaniu.
 
 .. image:: /_static/login_confirmed.png