Verified Commit 82d9ab82 authored by Jakob Moser's avatar Jakob Moser
Browse files

Reformat files

parent 3582366c

CONTRIBUTING.md

+6 −6
Changes for CONTRIBUTING.md: 6 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ new Service( 


It has a human-readable name (“Meeting”), the URL to link to (https://fachschaft.cl.uni-heidelberg.de/meet) and a Font Awesome icon name. To find an icon, browse the Font Awesome collection, click the icon, and copy the `class` (e.g. if the HTML code is `<i class="fa-solid fa-alarm-clock"></i>`, copy `fa-solid fa-alarm-clock`)



* [Font Awesome 7 Free Collection](https://fontawesome.com/v7/search?ic=free-collection)

- [Font Awesome 7 Free Collection](https://fontawesome.com/v7/search?ic=free-collection)



There are optional attributes when creating a `Service`:
@@ -39,7 +39,7 @@ Then, there are two cases: 


Open the services file:



* [`portal/static/js/model/services.mjs`](./portal/static/js/model/services.mjs)

- [`portal/static/js/model/services.mjs`](./portal/static/js/model/services.mjs)



Put the `Service` you created in that list. The first five entries are also shown on `/`, all services are shown on `/fs-services` in alphabetic order.
@@ -47,11 +47,11 @@ Put the `Service` you created in that list. The first five entries are also show 


Open the main Portal JavaScript file:



* [`portal/static/js/portal.mjs`](./portal/static/js/portal.mjs)

- [`portal/static/js/portal.mjs`](./portal/static/js/portal.mjs)



In there, you see a mapping from path segments to page names. In the case of `/uni-services`, that would be `UniServices` from the corresponding file `UniServices.mjs`. All these files are stored in the `pages/` directory.



* [`portal/static/js/components/pages/` directory](./portal/static/js/components/pages/)

- [`portal/static/js/components/pages/` directory](./portal/static/js/components/pages/)



Wrap the service you created in a `ServiceLink`, and put it in the list:
@@ -62,7 +62,7 @@ m( 
        "Meeting",

        "https://fachschaft.cl.uni-heidelberg.de/meet",

        "fa-solid fa-phone-volume",

    )

    ),

)

```
@@ -70,7 +70,7 @@ m( 


To find out where your changes should go to implement a particular feature or fix a bug, read the architecture documentation. This document will also link to further documentation and code as needed.



* [Architecture documentation](./docs/architecture.md)

- [Architecture documentation](./docs/architecture.md)



## Formatting

README.md

+2 −2
Changes for README.md: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -36,8 +36,8 @@ See the [Contributing Guide](./CONTRIBUTING.md) for more details on how to contr 


Install necessary dependencies:



* [Git](https://git-scm.com/)

* [uv](https://docs.astral.sh/uv/#installation)

- [Git](https://git-scm.com/)

- [uv](https://docs.astral.sh/uv/#installation)



On the pool computers, Git is already installed, and uv can be installed with:

alembic/versions/2a60cb3fb390_initialize_database.py

+5 −5
Changes for alembic/versions/2a60cb3fb390_initialize_database.py: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -6,17 +6,17 @@ Create Date: 2024-06-02 16:00:40.676901 


"""



from typing import Sequence, Union

from collections.abc import Sequence



from alembic import op

import sqlalchemy as sa



from alembic import op



# revision identifiers, used by Alembic.

revision: str = "2a60cb3fb390"

down_revision: Union[str, None] = None

branch_labels: Union[str, Sequence[str], None] = None

depends_on: Union[str, Sequence[str], None] = None

down_revision: str | None = None

branch_labels: str | Sequence[str] | None = None

depends_on: str | Sequence[str] | None = None





def upgrade() -> None:

alembic/versions/6c174457829c_add_taigauserstoryprovider.py

+5 −6
Changes for alembic/versions/6c174457829c_add_taigauserstoryprovider.py: 5 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -6,19 +6,18 @@ Create Date: 2024-06-03 18:50:22.330381 


"""



from typing import Sequence, Union

from collections.abc import Sequence



from alembic import op

import sqlalchemy as sa



from alembic import op

from portal.model import Uuid





# revision identifiers, used by Alembic.

revision: str = "6c174457829c"

down_revision: Union[str, None] = "d3889051d9e7"

branch_labels: Union[str, Sequence[str], None] = None

depends_on: Union[str, Sequence[str], None] = None

down_revision: str | None = "d3889051d9e7"

branch_labels: str | Sequence[str] | None = None

depends_on: str | Sequence[str] | None = None





def upgrade() -> None:

alembic/versions/d3889051d9e7_add_users_and_keys.py

+6 −6
Changes for alembic/versions/d3889051d9e7_add_users_and_keys.py: 6 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -6,20 +6,20 @@ Create Date: 2024-06-04 16:07:36.652116 


"""



from typing import Sequence, Union

from collections.abc import Sequence



from alembic import op

import sqlalchemy as sa



from alembic import op



# revision identifiers, used by Alembic.

revision: str = "d3889051d9e7"

down_revision: Union[str, None] = "2a60cb3fb390"

branch_labels: Union[str, Sequence[str], None] = None

depends_on: Union[str, Sequence[str], None] = None

down_revision: str | None = "2a60cb3fb390"

branch_labels: str | Sequence[str] | None = None

depends_on: str | Sequence[str] | None = None





from portal.model import Uuid, UtcDateTime

from portal.model import UtcDateTime, Uuid





def upgrade() -> None: