michael/pyfedi
1
0
Fork 0
mirror of https://codeberg.org/rimu/pyfedi synced 2025-01-23 11:26:56 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

move project management docs to their own directory

Browse source
This commit is contained in:
rimu 2024-04-07 16:06:42 +12:00
parent b8ddf0c481
commit 502cf34edd
6 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -16,3 +16,4 @@ To build a federated discussion and link aggregation platform, similar to Reddit
- [Screencast: overview of the PieFed codebase](https://join.piefed.social/2024/01/22/an-introduction-to-the-piefed-codebase/) - [Screencast: overview of the PieFed codebase](https://join.piefed.social/2024/01/22/an-introduction-to-the-piefed-codebase/)
- [Database / entity relationship diagram](https://join.piefed.social/wp-content/uploads/2024/02/PieFed-entity-relationships.png) - [Database / entity relationship diagram](https://join.piefed.social/wp-content/uploads/2024/02/PieFed-entity-relationships.png)
- see [INSTALL.md](INSTALL.md) - see [INSTALL.md](INSTALL.md)
- see docs/project_management/* for a project roadmap, contributing guide and much more.

2
CONTRIBUTING.md → docs/project_management/contributing.md
View file

@ -26,7 +26,7 @@ Mailing list, Matrix channel, etc still to come.
- Redis - Redis
Python developers with no Flask experience can quickly learn Flask by exploring the Python developers with no Flask experience can quickly learn Flask by exploring the
[Flask Mega Tutorial](https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world) [Flask Mega Tutorial](https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world-2018)
which will guide them through the process of building a simple social media app. Django is which will guide them through the process of building a simple social media app. Django is
very similar to Flask so developers familiar with that framework will have an easier very similar to Flask so developers familiar with that framework will have an easier
time of things. time of things.

4
docs/project_management/decision_log.md Normal file
View file

@ -0,0 +1,4 @@
# Decision log
This document helps prevent rearguing decisions after they have been made. It can also help new contributors come up to
speed by providing a summary of how we got to the present state.

0
GOVERNANCE.md → docs/project_management/governance.md
View file

6
ROADMAP.md → docs/project_management/roadmap.md
View file

@ -29,15 +29,15 @@ The following are the goals for a 1.0 release, good enough for production use. I
### Moderation ### Moderation
- community moderation - ✅ community moderation
- ✅ blocking - users, communities, domains, instances. bi-directional. - ✅ blocking - users, communities, domains, instances. bi-directional.
- import/export of block lists - import/export of block lists
### Onboarding ### Onboarding
- ✅ choose interests to auto-subscribe new accounts - ✅ choose topics to auto-subscribe new accounts
### Performance and scaling ### Performance and scaling
- ✅ background task runner - ✅ background task runner
- send queue for federation

11
docs/project_management/who_is_who.md Normal file
View file

@ -0,0 +1,11 @@
# People involved in PieFed
This document gives the community a shared understanding of who is responsible for what and helps to make sure no one
is inadvertently left out of a decision.
### Rimu
- https://piefed.social/u/rimu, https://mastodon.nzoss.nz/@rimu
Founder and lead developer. Approver of PRs, payer of bills.