created base gallery app, made start on documentation.
Some checks failed
Gitea Test. / tests (push) Has been cancelled
Some checks failed
Gitea Test. / tests (push) Has been cancelled
This commit is contained in:
24
docs/ROADMAP.md
Normal file
24
docs/ROADMAP.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Goals
|
||||
|
||||
This document contains the wanted feature list and their current state.
|
||||
|
||||
## Basic Pages
|
||||
|
||||
-[] Homepage
|
||||
-[] Boards
|
||||
-[] Committee page
|
||||
-[] Contact page
|
||||
-[] Donator page/Friends of Quatsh
|
||||
-[] Membership page
|
||||
|
||||
## Main Features
|
||||
|
||||
-[] Signup form with email SMTP link.
|
||||
-[] Gallery
|
||||
-[] Login page
|
||||
|
||||
## Extra's
|
||||
|
||||
-[] Allow google-workspace login with SSO?
|
||||
-[] Add Redis for Caching
|
||||
-[] Setup SMTP with automatic switching to in-mem email saving OR print to stdout when in DEBUG mode.
|
||||
0
docs/architecture/decisions.md
Normal file
0
docs/architecture/decisions.md
Normal file
72
docs/templates/template.md
vendored
Normal file
72
docs/templates/template.md
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
# Feature Name
|
||||
|
||||
> One sentence description of what this feature does and who it is for.
|
||||
|
||||
## Status
|
||||
<!-- Delete all that do not apply -->
|
||||
`Planned` `In Progress` `In Review` `Complete` `Deferred`
|
||||
|
||||
## Background
|
||||
<!-- Why are we building this? What problem does it solve? Link to any relevant roadmap phase. -->
|
||||
|
||||
## Scope
|
||||
<!-- What is included in this feature. Be explicit about what is out of scope too. -->
|
||||
|
||||
**In scope:**
|
||||
-
|
||||
|
||||
**Out of scope:**
|
||||
-
|
||||
|
||||
## User Stories
|
||||
<!-- Who interacts with this feature and what do they want to achieve? -->
|
||||
- As a **[member / board member / anonymous visitor]**, I want to **[action]** so that **[outcome]**.
|
||||
|
||||
## Data Model
|
||||
<!-- What models are created or modified? List fields and their types. -->
|
||||
|
||||
```python
|
||||
class ExampleModel(models.Model):
|
||||
pass
|
||||
```
|
||||
|
||||
**Related models:**
|
||||
- `User` —
|
||||
|
||||
## GDPR Considerations
|
||||
<!-- See docs/gdpr/ for shared policies. Only document what is specific to this feature. -->
|
||||
|
||||
| Question | Answer |
|
||||
|---|---|
|
||||
| Personal data collected | |
|
||||
| Legal basis | Legitimate interest / Consent / Legal obligation |
|
||||
| Retention period | See `docs/gdpr/retention-policy.md` / [custom policy] |
|
||||
| Erasure behaviour | Cascade delete / Anonymise / Transfer ownership |
|
||||
| Visible to non-members | Yes / No |
|
||||
|
||||
## Open Questions
|
||||
<!-- Unresolved decisions that are blocking or will affect implementation. -->
|
||||
- [ ]
|
||||
|
||||
## Decisions Log
|
||||
<!-- Record decisions made during development so future contributors understand why things are the way they are. -->
|
||||
|
||||
| Date | Decision | Reasoning |
|
||||
|---|---|---|
|
||||
| YYYY-MM-DD | | |
|
||||
|
||||
## Tasks
|
||||
<!-- Break the feature down into concrete implementation steps. -->
|
||||
|
||||
### Backend
|
||||
- [ ]
|
||||
|
||||
### Frontend
|
||||
- [ ]
|
||||
|
||||
### Tests
|
||||
- [ ]
|
||||
|
||||
## Related
|
||||
<!-- Links to related feature files, external docs, or GitHub issues. -->
|
||||
-
|
||||
Reference in New Issue
Block a user