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]: Update wiki #4550

Open
2 tasks done
jimmyli97 opened this issue Jul 25, 2024 · 12 comments
Open
2 tasks done

[DOCS]: Update wiki #4550

jimmyli97 opened this issue Jul 25, 2024 · 12 comments

Comments

@jimmyli97
Copy link
Contributor

jimmyli97 commented Jul 25, 2024

Is there an existing request for this change?

  • I have searched the existing issues

Context for documentation change

Wiki is outdated:

  • Old names
  • Old pages have things that have already been merged
  • Missing some classes in Event Sourcing
  • outdated infrastructure info

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

  • I've read the Code of Conduct and understand my responsibilities as a member of the Ruby for Good community
@dorner
Copy link
Collaborator

dorner commented Jul 26, 2024

@cielf did you want to look at these patches? 

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

@jimmyli97
Copy link
Contributor Author

jimmyli97 commented Jul 27, 2024

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
Copy link
Collaborator

cielf commented Jul 27, 2024

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
Copy link
Contributor Author

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

@awwaiid awwaiid modified the milestone: Tasks 2024 Jul 28, 2024
@cielf
Copy link
Collaborator

cielf commented Jul 29, 2024

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
Copy link
Contributor Author

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
Copy link
Collaborator

cielf commented Aug 1, 2024

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
Copy link
Contributor Author

@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
Copy link
Collaborator

cielf commented Aug 2, 2024

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
Copy link
Collaborator

cielf commented Aug 2, 2024

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
Copy link
Contributor Author

@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
Copy link
Collaborator

cielf commented Aug 7, 2024

Seems good to me.

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

No branches or pull requests

4 participants