rubyforgood / human-essentials

Human Essentials is an inventory management system for diaper, incontinence, and period-supply banks. It supports them in distributing to partners, tracking inventory, and reporting stats and analytics.
https://humanessentials.app
MIT License
446 stars 473 forks source link

[DOCS]: Update wiki #4550

Open jimmyli97 opened 2 months ago

jimmyli97 commented 2 months ago

Is there an existing request for this change?

Context for documentation change

Wiki is outdated:

Proposed solution

I forked it, created some commits, and created patches from those commits which someone with write access can approve and apply.

Preview of all changes at my fork

Patches available here: 1) Replace all references of DiaperBase with Human Essentials (link) 2) Replace all references of PartnerBase with Partner model (link) 3) Remove outdated pages (link) 4) Remove outdated info on infrastructure (link) 5) Add info to Event Sourcing on Flipper flag, TestInventory, and CRUD services (link) 6) Update overview to include super admin and partner scope (link) 7) Move references to Partner Base in Base-Items to history section, remove outdated info (link)

Code of Conduct

dorner commented 2 months ago

@cielf did you want to look at these patches? 

@jimmyli97 can you follow the approach mentioned here? https://stackoverflow.com/a/56810747/5199431

jimmyli97 commented 2 months ago

got it, I will add that to CONTRIBUTING as well

the following should work to merge changes and clean up

git clone https://github.com/rubyforgood/human-essentials.wiki.git && \
cd human-essentials.wiki && \
git pull https://github.com/jimmyli97/human-essentials.wiki.git master && \
git push origin master && \
cd ../ && \
rm -rf human-essentials.wiki
cielf commented 2 months ago

I notice that we are still using diaper bank /diaperbank in several places. That should be changed to essentials bank. I don't see anything that I would block in these patches.

jimmyli97 commented 2 months ago

Edited Home, BaseItem, and Application Overview to remove most instances of Diaperbank and replace with Essentials bank (left it alone in History sections, and also added a note that most common type is Diaperbank)

Edits visible here

cielf commented 2 months ago

I took a quick look and there are still some references to diaperbank on both Base Items and Application Overview . Also noting that It should be Essentials Bank , not Essentials bank. "essentials bank" is also ok, but the capitalized version is preferred. I don't know if that's what the pattern was before

jimmyli97 commented 1 month ago

Capitalized all the Essentials Banks and removed all references to diaperbank except when talking about National Diaperbank Network on Application Overview.

Edited Home, Application Overview, Base Items Visible here

cielf commented 1 month ago

Although there are definitely still some old terminology uses in here (sb Product Drives instead of Diaper Drives, for instance), It's better than before, and I'm ok with it to go in. @jimmyli97 Is your goal for this PR to get the Wiki 100% up to date?

jimmyli97 commented 1 month ago

@cielf I'm happy to do that, I just wanted to make onboarding easier by linking to an updated wiki in CONTRIBUTING

however, I see a "Developer Architecture Overview" in docs/readme.md, is the plan to move the wiki to the Jekyll user guide site? or are we keeping the wiki as it is?

cielf commented 1 month ago

I hadn't been giving the wiki any thought at all until you put in this PR. I don't think the two have to be together in the short to medium term, and it should be pretty easy to move as a separate effort later.

cielf commented 1 month ago

In the longer term, it makes sense to me to have them together for ease of updating, but that can wait until the user guide is done, which will probably be the end of the year-ish.

jimmyli97 commented 1 month ago

@cielf changed terminology to Product Drive, added DiaperDrive to history section, replaced Site Admin with Super Admin on Application Overview page

I didn't notice anything else, let me know if there's anything else to change

cielf commented 1 month ago

Seems good to me.