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

Add PlantUML processing and example #3219

Merged
merged 26 commits into from
Jul 14, 2023
Merged

Add PlantUML processing and example #3219

merged 26 commits into from
Jul 14, 2023

Conversation

awwaiid
Copy link
Collaborator

@awwaiid awwaiid commented Oct 30, 2022

Experimental in-tree generated diagrams

@awwaiid
Copy link
Collaborator Author

awwaiid commented Mar 26, 2023

This is now ready for review/merge. It ended up with:

@awwaiid awwaiid marked this pull request as ready for review March 26, 2023 01:51
@awwaiid awwaiid requested a review from dorner March 26, 2023 01:52
@awwaiid awwaiid changed the title [WIP] Add PlantUML processing and example Add PlantUML processing and example Mar 26, 2023
Copy link
Collaborator

@dorner dorner left a comment

Choose a reason for hiding this comment

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

One comment on the technical side - I think @cielf needs to look at this from an app experience perspective. From what I know it looks really good!

doc/architecture/overview.md Outdated Show resolved Hide resolved
@cielf
Copy link
Collaborator

cielf commented Apr 1, 2023

Sorry I haven't gotten to this yet -- it feels like something I should look at when I'm fresh!

Copy link
Collaborator

@cielf cielf left a comment

Choose a reason for hiding this comment

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

Overall, I think this is going to be very helpful to folk. We also just added announcements, and will be adding counties -- do those get a place here too?


### Intake

A Diaperbank will acquire inventory primarily through one of two methods: a **Donation** or a **Purchase**. Purchases are straightforward; the Diaperbank spends its own money to purchase inventory. Donations can be received through a few different means.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Terminology note: We've gone almost entirely away from diaper-specific terminology. So it should be Essentialsbank, Productdrive

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I went through and switched most of the Diaper references to Essentials

**Diaperdrives** are like food drives -- a campaign, typically with advertisement to the community, for the general public to provide needed items to the diaperbank. Sometimes people will also donate inventory at a local **Donation Site**, outside of a Diaperdrive. Other than those two primary methods, there is a miscellaneous classification for diapers that are received (but not purchased) through other means.

Donations can also dropped off at **Donation Sites**. These are locations that have been designated as places where people can drop off donations.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also Manufacturer

doc/architecture/overview.md Show resolved Hide resolved
Sometimes, the diaper banks will need to make a correction, this application calls them **Adjustment**s.

When a diaper bank wants to move inventory from one storage location to another, they do so with a **Transfer**.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Add something about Audits

doc/architecture/overview.md Show resolved Hide resolved
3. Prompt the user to create a new barcode record using this value

For the second item, after the `BaseItem` is retrieved, it consults back to the Organization and finds the oldest `Item` (for that organization) that uses the retrieved `BaseItem`.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I love that we've got this kind of detail on barcodes somewhere.
If we've got this much detail at an overview level, though, we should also include kits
Or maybe break it up into more pieces

doc/architecture/overview.md Outdated Show resolved Hide resolved
@cielf
Copy link
Collaborator

cielf commented Apr 3, 2023

@awwaiid We'll also want to put something into the README to direct people to this.

@awwaiid
Copy link
Collaborator Author

awwaiid commented Apr 16, 2023

Consider adding announcements or other concepts

@awwaiid
Copy link
Collaborator Author

awwaiid commented Jul 2, 2023

I think I've addressed most of the feedback. If it looks tolerable for a draft then I'd like to merge it. As part of preparing for RFG-2023 I will submit further PRs for README cleanups which will link to this.

@awwaiid awwaiid requested review from cielf and dorner July 9, 2023 13:55
Copy link
Collaborator

@dorner dorner left a comment

Choose a reason for hiding this comment

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

I think it's way better than what we have now! Let's get it merged and make it better as needed. @cielf any objections?

@cielf
Copy link
Collaborator

cielf commented Jul 14, 2023

No objections.

@awwaiid awwaiid merged commit 3a0611a into main Jul 14, 2023
12 checks passed
@awwaiid awwaiid deleted the plantuml-action branch July 14, 2023 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants