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

Conversation

K-Beicher
Copy link
Contributor

@K-Beicher K-Beicher commented May 29, 2024

Description

  • This PR adds a PlantUML document detailing the repos and websites that we are currently working with.
  • The overview is a first draft and would likely benefit from being incorporated into a text document, but we need to decide if this is the best way to display the most important information first.

Related Issues

Closes seedcase-project/community#12

Reviewer Focus

This PR requires an in-depth review.

We need to look at whether this is a useful direction to go in with regards to creating an overview of our project. Or if there is a better way to keep track of our repos and websites.

Repos are denoted with 'folders' websites as documents within. Diamonds indicate that there is no website associated with the repo.

Checklist

For general documentation:

  • Spell-check
    • US
    • UK
  • Did the page(s) preview correctly on your machine without breaking
  • New category words (keywords) (if any) added to the code snippet file

@K-Beicher K-Beicher marked this pull request as ready for review May 29, 2024 07:27
@K-Beicher K-Beicher requested a review from a team as a code owner May 29, 2024 07:27
@signekb
Copy link
Member

signekb commented May 29, 2024

@K-Beicher as we talked about at the update meeting, I think the seedcase-theme repo is missing from the overview

@K-Beicher
Copy link
Contributor Author

K-Beicher commented May 29, 2024

Thank you for the reminder @signekb. Theme has now been added, the whole thing now looks like this, I'm not happy with the arrow from About to About.

Screenshot 2024-05-29 at 14 00 01

Copy link
Member

@signekb signekb left a comment

Choose a reason for hiding this comment

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

Very nice! I think this is a nice overview of what we have so far. I have added a lot of casing suggestions and a comment referring to @lwjohnst86's comment during today's meeting (29/05/2024) that it might be a nice alternative to do this in Mermaid instead to include clickable links instead of writing them as text here.

}

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?

entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
entries/repo-website-overview.puml Outdated Show resolved Hide resolved
minor style changes

Co-authored-by: Signe Kirk Brødbæk <[email protected]>
@lwjohnst86
Copy link
Member

@K-Beicher If you can't finish this yet and want to come back to it, move it over to in progress. Best not to merge things that have requested changes unless there is a time critical reason ☺️

@lwjohnst86 lwjohnst86 marked this pull request as draft June 26, 2024 08:30
@lwjohnst86 lwjohnst86 self-assigned this Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

Create document listing all the different websites and products (so far)
3 participants