diff --git a/README.md b/README.md index 465b8dc0..68eb582c 100644 --- a/README.md +++ b/README.md @@ -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/) - [Database / entity relationship diagram](https://join.piefed.social/wp-content/uploads/2024/02/PieFed-entity-relationships.png) - see [INSTALL.md](INSTALL.md) +- see docs/project_management/* for a project roadmap, contributing guide and much more. diff --git a/CONTRIBUTING.md b/docs/project_management/contributing.md similarity index 99% rename from CONTRIBUTING.md rename to docs/project_management/contributing.md index e2ce8798..f09ea3d3 100644 --- a/CONTRIBUTING.md +++ b/docs/project_management/contributing.md @@ -26,7 +26,7 @@ Mailing list, Matrix channel, etc still to come. - Redis 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 very similar to Flask so developers familiar with that framework will have an easier time of things. diff --git a/docs/project_management/decision_log.md b/docs/project_management/decision_log.md new file mode 100644 index 00000000..210b3b58 --- /dev/null +++ b/docs/project_management/decision_log.md @@ -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. diff --git a/GOVERNANCE.md b/docs/project_management/governance.md similarity index 100% rename from GOVERNANCE.md rename to docs/project_management/governance.md diff --git a/ROADMAP.md b/docs/project_management/roadmap.md similarity index 88% rename from ROADMAP.md rename to docs/project_management/roadmap.md index 1ab115a7..0094e542 100644 --- a/ROADMAP.md +++ b/docs/project_management/roadmap.md @@ -29,15 +29,15 @@ The following are the goals for a 1.0 release, good enough for production use. I ### Moderation -- community moderation +- ✅ community moderation - ✅ blocking - users, communities, domains, instances. bi-directional. - import/export of block lists ### Onboarding -- ✅ choose interests to auto-subscribe new accounts +- ✅ choose topics to auto-subscribe new accounts ### Performance and scaling - ✅ background task runner - +- send queue for federation diff --git a/docs/project_management/who_is_who.md b/docs/project_management/who_is_who.md new file mode 100644 index 00000000..311d3f58 --- /dev/null +++ b/docs/project_management/who_is_who.md @@ -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. +