docs: open source preparations

IntersectMBO · Apr 16, 2024 · f1de0bb · f1de0bb
1 parent 20b0cd2
commit f1de0bb
Show file tree

Hide file tree

Showing 30 changed files with 15 additions and 370 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -106,6 +106,7 @@ changes.
 - Extend the eslint config to apply to the style guide of the project [Issue 514](https://github.com/IntersectMBO/govtool/issues/514)
 - Update frontend package readme to reflect recent changes [Issue 543](https://github.com/IntersectMBO/govtool/issues/543)
 - Change input selection strategy to 3 (random) [Issue 575](https://github.com/IntersectMBO/govtool/issues/575)
+- Changed documents to prepare for open source [Issue 737](https://github.com/IntersectMBO/govtool/issues/737)
 
 ### Removed
 

diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[XXXX@intersectmbo.org](XXXX@intersectmbo.org).
+[oso@intersectmbo.org](oso@intersectmbo.org).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,12 @@
 # Contributing to the `GovTool` project
 
+⚠️ This is a work in progress document, more instruction on how-to contribute to come!
+
+Contributing todo:
+- [ ] Align with latest OSC policies
+- [ ] Refactor to reflect reality
+- [ ] Make more friendly to open source contributors
+
 Thanks for considering contributing and helping us on creating GovTool! 😎
 
 The best way to contribute right now is to try things out and provide feedback, but we also accept contributions to the documentation and the obviously to the code itself.

diff --git a/README.md b/README.md
@@ -25,27 +25,19 @@ Learn more; [docs.sanchogov.tools](https://docs.sanchogov.tools/).
 
 - [GovTool Backend](./govtool/backend/README.md)
 - [GovTool Frontend](./govtool/frontend/README.md)
-- [GovTool deployment setup](./scripts/govtool/README.md)
+- [GovTool Infrastructure](./infra/)
 - [Documentation](./docs/)
 - [Tests](./tests/)
 
 ### Utilities
 
-- [Governance Action Loader](./src/governance-action-loader/)
-
-## 🔩 Architecture
-
-GovTool consists of a Haskell backend and a React Typescript frontend.
+- [Governance Action Loader](./governance-action-loader/)
 
 ### Backend
 
 GovTool backend implements an API wrapper around an instance of [DB-Sync](https://github.com/IntersectMBO/cardano-db-sync) which interfaces with a [Cardano Node](https://github.com/IntersectMBO/cardano-node).
 The API exposes endpoints making the querying of governance related data from DB-Sync straight forward.
 
-#### API Reference
-
-[`Swagger documentation`](https://sanchogov.tools/api/swagger-ui/)
-
 ### Frontend
 
 GovTool frontend web app communicates with the backend over a REST interface, reading and displaying on-chain governance data.
@@ -54,4 +46,7 @@ Frontend is able to connect to Cardano wallets over the [CIP-30](https://github.
 ## 🤝 Contributing
 
 Thanks for considering contributing and helping us on creating GovTool! 😎
+
+⚠️ We are in the process of improving our contributing documentation, improvements to come.
+
 Please checkout our [Contributing Documentation](./CONTRIBUTING.md).
diff --git a/SECURITY.md b/SECURITY.md
@@ -2,7 +2,7 @@
 
 ## Reporting a Vulnerability
 
-Please report (suspected) security vulnerabilities to [XXXX@intersectmbo.org](XXXX@intersectmbo.org).
+Please report (suspected) security vulnerabilities to [oso@intersectmbo.org](oso@intersectmbo.org).
 You will receive a response from us within 48 hours.
 If the issue is confirmed, we will release a patch as soon as possible.
 

diff --git a/docs/architecture/.gitignore b/docs/architecture/.gitignore
diff --git a/docs/architecture/arch-structurizr/README.md b/docs/architecture/arch-structurizr/README.md
diff --git a/docs/architecture/arch-structurizr/dapp.dsl b/docs/architecture/arch-structurizr/dapp.dsl
diff --git a/docs/architecture/arch-structurizr/decisions/0001-decision b/docs/architecture/arch-structurizr/decisions/0001-decision
diff --git a/docs/architecture/arch-structurizr/docker-compose.yml b/docs/architecture/arch-structurizr/docker-compose.yml
diff --git a/docs/architecture/arch-structurizr/documentation/documentation.md b/docs/architecture/arch-structurizr/documentation/documentation.md
diff --git a/docs/architecture/arch-structurizr/workspace.dsl b/docs/architecture/arch-structurizr/workspace.dsl
diff --git a/docs/architecture/dapp-arch-v1.1.PNG b/docs/architecture/dapp-arch-v1.1.PNG
diff --git a/docs/architecture/dapp-user-states.PNG b/docs/architecture/dapp-user-states.PNG
diff --git a/docs/architecture/sequence-diagrams/delegation-status.png b/docs/architecture/sequence-diagrams/delegation-status.png
diff --git a/docs/architecture/sequence-diagrams/delegation.png b/docs/architecture/sequence-diagrams/delegation.png
diff --git a/docs/architecture/sequence-diagrams/drep-registration.png b/docs/architecture/sequence-diagrams/drep-registration.png
diff --git a/docs/architecture/sequence-diagrams/drep-retirement.png b/docs/architecture/sequence-diagrams/drep-retirement.png
diff --git a/docs/architecture/sequence-diagrams/drep-status.png b/docs/architecture/sequence-diagrams/drep-status.png
diff --git a/docs/architecture/sequence-diagrams/login.png b/docs/architecture/sequence-diagrams/login.png
diff --git a/docs/architecture/sequence-diagrams/raw/delegation-status.txt b/docs/architecture/sequence-diagrams/raw/delegation-status.txt
diff --git a/docs/architecture/sequence-diagrams/raw/delegation.txt b/docs/architecture/sequence-diagrams/raw/delegation.txt
diff --git a/docs/architecture/sequence-diagrams/raw/drep-registration.txt b/docs/architecture/sequence-diagrams/raw/drep-registration.txt
diff --git a/docs/architecture/sequence-diagrams/raw/drep-retirement.txt b/docs/architecture/sequence-diagrams/raw/drep-retirement.txt
diff --git a/docs/architecture/sequence-diagrams/raw/drep-status.txt b/docs/architecture/sequence-diagrams/raw/drep-status.txt