Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create overview of repos and websites for all of seedcase #152

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
80 changes: 80 additions & 0 deletions entries/repo-website-overview.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
@startuml Repos-Sites

package .github as GIT {
diamond dia1
}

package data as DAT {
diamond dia2
}

package theme as THE {
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
diamond dia3
}

package community as COM {
object "Community.Seedcase-Project.org" as CSP {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As Luke mentioned on the meeting, it might be an idea to use Mermaid as done in the SDCA research-ops repo here so we can add a link directly to the websites instead of writing the url?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lwjohnst86 Thoughts? Should the puml be changed to mermaid?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes please! Mermaid is easier to use to incorporate clickable links.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The re-write in Mermaid will have to wait until after my summer holiday, do you guys want to merge this in, and then I can create an issue on converting it to Mermaid, or should I move this back into draft to make it go away from my lists?

K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
Project blocks
Roadmap
Guides
Posts
Outreach
Code of Conduct
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
}
}

package decisions as DEC {
object "Decisions.Seedcase-Project.org" as DeCP {
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
Posts
}
}

package design as DES {
object "Design.Seedcase-Project.org" as DeSP {
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
Welcome
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
Software architecture documentation
}
}

package team as TEA {
object "Team.Seedcase-Project.org" as TSP {
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
Onboarding
Entries
User Tests
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
Events
}
}

package "Seedcase Sprout" as SPROUT {
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
object "localhost" as SSP {
App for upload
and storing data
}
}

package seedcase {
object "About Seedcase" as ABOUT {
history
team members
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
}

object "Learn" as LEA {
Learning Shorts
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
}
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved

map "Seedcase-Project.org" as SP {
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
about seedcase *-> ABOUT
community *--> COM
design *--> DES
decisions *--> DEC
learn *-> LEA
K-Beicher marked this conversation as resolved.
Show resolved Hide resolved
}
}

COM -[hidden]--> TEA
DEC -[hidden]--> GIT
DEC -[hidden]--> DAT
DEC -[hidden]--> THE
SPROUT -[hidden]--> COM

@enduml