Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# -- Project information -----------------------------------------------------

project = 'F-sek'
copyright = '2024, F-sektionen inom TLTH'
copyright = '2025, F-sektionen inom TLTH'
author = 'F-sektionen'

# The short X.Y version
Expand Down
286 changes: 286 additions & 0 deletions source/examples/backend/backend.rst

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions source/examples/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ provide some understanding of underlying code mechanics.
:Caption: Contents

./app/app
./backend/backend
./frontend/frontend
466 changes: 466 additions & 0 deletions source/examples/frontend/frontend.rst

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@


.. _install_git:
==============
Setting up Git
==============
Expand Down
2 changes: 1 addition & 1 deletion source/installing_systems/operating_systems.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Which OS should I use?
Windows Subsystems for Linux (WSL)
==================================

This might be the easisest and fastest way to get a Linux environment up and running. To install a WSL, simply head to the Windows Store and search
This might be the easiest and fastest way to get a Linux environment up and running. To install a WSL, simply head to the Windows Store and search
for Ubuntu (there are many different Linux versions or distributions but Ubuntu is the most widely used). Simply download and install the app and then
you need to run a command in PowerShell. Open PowerShell as an administrator (right click and select *Run as administrator*) and run the following command::

Expand Down
Binary file removed source/pictures/fixa-snabblänk.png
Binary file not shown.
Binary file removed source/pictures/hitta-mailalias.png
Binary file not shown.
Binary file removed source/pictures/hitta-snabblänk.png
Binary file not shown.
Binary file removed source/pictures/mailalias.png
Binary file not shown.
Binary file removed source/pictures/medlemskap.png
Binary file not shown.
Binary file removed source/pictures/vägbeskrivning.png
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Spider Conference 2024
======================

The Spider Conference 2024 was the most grand Spider Conference in the history of the Spidermans. To not spoil anything for the new Spiders this site will be updated later in 2025.
The Spider Conference 2024 was the most grand Spider Conference in the history of the Spidermans. To not spoil anything for the new Spiders this site will be updated later in 2025 (or not).
65 changes: 14 additions & 51 deletions source/spiderman_duties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,11 @@ Godkänna användare

Då medlemmar hör av sig till spindelmännen om att de inte har behörighet någonstans eller att de inte kan använda någon funktion på hemsidan är det troligtvis så att de inte är godkända användare. Detta är enkelt löst.

Steg 1: Gå in på ''Administrera''-menyn och välj ''Användare''.
Steg 1: Gå in till "Admin"-sidan och välj "Medlemmar".

.. image:: pictures/vägbeskrivning.png
:alt: Sätt att hitta användare
Steg 2: Sök upp personen i fråga.


Steg 2: Klicka ''Ge medlemskap''

.. image:: pictures/medlemskap.png
:alt: Medlemskap
Steg 3: Klicka "Gör till medlem".

Klar!

Expand All @@ -28,59 +23,27 @@ Klar!
Create mail alias
=================

There is a lot of members that what ot have their own cool mail alias for their blabla in the F-guild. Note that this is only an alias and **not** an new email. These aliases only forward mail to an already excisting email adress. To create a new mail alias you use the website. We can create aliases for name@fsektionen.se or name@farad.nu.

**Step 1**: Log into the website and go to "Administrate" menu and choose "Mail aliases" in the "User" column.

Det är många medlemmar som vill ha egna coola mailalias för sitt engagemang på F-sektionen. Observera dock att detta endast är ett alias och INTE en ny mailadress. Dessa mailalias bara vidarebefodrar till en existerande emailadress som medlemmen äger. Skapa mailalias gör du via hemsidan. Vi kan skapa mailalias för blablabla@fsektionen.se eller blablabla@farad.nu.

Steg 1: Gå in på ''Administrera''-menyn och välj ''Mailalias''.
There are a lot of members that want to have their own cool mail alias for their posts or similar official positions in the F-guild. Note that this is only an alias and **not** an new email. These aliases only forward mail to an already excisting email adress. To create a new mail alias you use the website. We can create aliases for name@fsektionen.se (and maybe name@farad.nu).

.. image:: pictures/hitta-mailalias.png
:alt: Sätt att hitta användare
**Step 1**: Log into the website, go to the admin page and choose "Mail aliases" in the "Webmaster Only" category.

**Step 2**: Search to see if the mailalias already exists, otherwise add it.

Steg 2: Skriv in önskad mailalias i sökrutan och klicka sök.
**Step 3**: Add the persons personal email adress as a target of the source alias. Changes are saved automatically.

Steg 3: Skriv in mailadress som önskas kopplas till mailaliaset. Glöm inte att trycka på "Spara"-knappen!

.. image:: pictures/mailalias.png
:alt: Sätt att skapa mailalias


Klar!
Done!

==========================================
Ändra mailadresser kopplade till mailalias
==========================================

Steg 1: Gå in på ''Administrera''-menyn och välj ''Mailalias''.


Steg 2: Klicka på "Redigera"-knappen så öppnas ett fält med nuvarande mailadresser kopplade till mailaliaset.

.. image:: pictures/hitta-mailalias.png
:alt: Sätt att hitta användare


Steg 3: Skriv till en mailadress på en ny rad eller ändra en befintlig. Glöm inte att trycka på "Spara"-ikonen!

Klar!


===============
Skapa snabblänk
===============

Steg 1: Gå in på ''Administrera''-menyn och välj ''Snabblänkar''.
Detta sker på ett sätt mycket likt ovanstående guide.

.. image:: pictures/hitta-snabblänk.png
:alt: Sätt att hitta snabblänk
Steg 1: Gå till mailaliassidan från adminsidan.

Steg 2: Skriv in namn på snabblänken i vänster fält och vart snabblänken ska leda i höger fält. Alltså, snabblänken kommer se ut fsektionen.se/google och när man klickar på denna så kommer man till www.google.com
Steg 2: Sök upp mailalias.

.. image:: pictures/fixa-snabblänk.png
:alt: Sätt att fixa snabblänk
Steg 3: Använd plus/minus knapparna eller klicka på ett namn för att ändra.

Klar!

Expand All @@ -92,7 +55,7 @@ Steg 1: Läs mailet.

Steg 2: Tänk ut ett bra svar på mailet som är hjälpsamt.

Steg 3: Skriv detta bra-iga svar och tänk på att vidarebefodra svaret till alla spindelmän!
Steg 3: Skriv detta bra-iga svar och tänk på att vidarebefodra svaret till alla spindelmän! Använd "Svara alla" t.ex.!

Steg 4: Du har nu +10000000 social credit points.

Expand All @@ -102,7 +65,7 @@ Klar!
Gå på möte
==========

Steg 1: Lägg in i din kalender vilka dagar som det är spindelmöte. Du kan också följa spindelkalendern.
Steg 1: Lägg in i din kalender vilka dagar som det är spindelmöte.

Steg 2: Kom till spindelmötet. Var inte sen!

Expand Down
6 changes: 3 additions & 3 deletions source/web/naming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Functions
The Python functions in a route definition should be named descriptively. The name of the function is used as a description in Swagger, which makes it easy to understand what a route is supposed to do in Swagger if named clearly. For example, a function named ``create_example`` will get the description "Create Example" in Swagger.

- **Use snake_case** for function names.
- Choose a name that describes the functions purpose clearly. For instance, ``create_example`` is more descriptive than ``example_creation``.
- Choose a name that describes the function's purpose clearly. For instance, ``create_example`` is more descriptive than ``example_creation``.

Schemas
-------

For many different objects, a lot of basic schemas will be used for similar purposes. One common naming convention is to follow CRUD (Create, Read, Update, and Delete), which describes how the most common schemas should be named.

Lets say we want to create some schemas for a database model called *Example*. For the different routes, the schemas should ideally be named:
Let's say we want to create some schemas for a database model called *Example*. For the different routes, the schemas should ideally be named:

- **POST route**: ``ExampleCreate``
- **GET route**: ``ExampleRead``
Expand All @@ -26,4 +26,4 @@ All schemas should be written in **PascalCase**.
Database Models
---------------

Database models should be written in **PascalCase** with the suffix ``_DB``. For example: ``C
Database models should be written in **PascalCase** with the suffix ``_DB``. For example: ``CrazyChairs_DB``.