search

Expensify / App

Welcome to New Expensify: a complete re-imagination of financial collaboration, centered around chat. Help us build the next generation of Expensify by sharing feedback and contributing to the code.
https://new.expensify.com
MIT License
3.36k stars 2.79k forks source link

Community Migration to HelpDot - C+ Assistance #27150

Closed maddylewis closed 11 months ago

maddylewis commented 1 year ago

Part of the Community Migration to HelpDot project

Main issue: https://github.com/Expensify/Expensify/issues/274365 Doc section: https://docs.google.com/document/d/1MjTYzA-uo7ShLjo8x3XLA7EkSAhx0Yc9W43PPnKV3co/edit#bookmark=id.g4dt3vbhlcro

Tracking Issue

Tl;dr: There's a 9/30 deadline for this migration to be completed (more details here). For that to happen, I need some engineering assistance.

To make this as easy as possible for our engineering team, I will parse out exactly what I need/what I have questions about so that those tasks can be completed whenever anyone has a spare moment!

Request 1 - Questions on publishing content

  1. When publishing a brand new article (not editing an existing article), is it possible for a non-engineer to preview an article before publishing it?
  2. Are C+s currently reviewing these PRs?
  3. Do we always need engineering to merge these PRs? Can we lower the threshold so that Ring5 is able to merge HelpDot PRs? Or, is that too risky?
  4. Is this the most up-to-date process for non-engineers publishing new content to the site or could this be simplified in any way?
  5. We will be publishing 100+ articles - Is there a certain cadence we should follow when publishing new articles? Can we publish everything at once? Should we go hub-by-hub?

Request 2 - Questions on publishing images

  1. What is the best way for non-engineers to include images when publishing new content?
  2. Should we request images from Design?
  3. Is there a specific way those images should be formatted when submitting the PR?

Request 3 - Confirming Category/Subcategory redesign structure is feasible

The current redesign entails:

Homepage Category Hubs:

image

Subcategory Hubs:

image

Request 4 - Detailed Design Doc Requests

Publishing the Content to HelpDot - Technical Details:

melvin-bot[bot] commented 1 year ago

Triggered auto assignment to @tjferriss (NewFeature), see https://stackoverflowteams.com/c/expensify/questions/14418#:~:text=BugZero%20process%20steps%20for%20feature%20requests for more details.

maddylewis commented 1 year ago

Request 1 answers:

  1. When publishing a brand new article (not editing an existing article), is it possible for a non-engineer to preview an article before publishing it? Yep! It will require some engineering-y things, but it's not too tricky. These instructions give you pretty good step by steps, really just copying and pasting in Terminal commands. The only tricky one is how to clone the repo, this should help. When you have a new page, it may not yet be in the nav, but you can always go directly to the page locally - for example, https://localhost:4000/articles/[article category]/[Article-Name]. Maybe give that a shot yourself and let me know if there's anything that's confusing and I can clarify as needed! It also might be good to update any SOs about creating help pages as soon as something needs to be changed, so that PRs 50-100 can learn from PRs 1-50, haha..
  2. Are C+s currently reviewing these PRs? Kinda. They're assigned, but don't always actually take a look - and I don't think for this that they have to, again, assuming that we get into a good rhythm of creating these pages correctly. Unfortunately, the bot will assign them first. I'm not sure if we can override this, do you know @neil-marcellini? Maybe we just instruct them to immediately approve, or we manually add the Engineering label to get an auto assign.
  3. Do we always need engineering to merge these PRs? Can we lower the threshold so that Ring5 is able to merge HelpDot PRs? Or, is that too risky? It's probably safest to have engineering merge them. If the page has been tested locally - and most importantly all the copy, images, and formatting have been double checked, all we'd have to do is spot check to make sure there's nothing weird going on so it would be a quick review (less than 5 min per page). The trick would be getting the engineer's attention, haha, and I have less of a tactic for that. If we're in a good flow of making sure the pages/PRs are ready to go, then you can bother me and I can try to go through open ones quickly.
  4. Is this the most up-to-date process for non-engineers publishing new content to the site or could this be simplified in any way? I think that's basically it! However, I believe you don't have to do steps 10 and 11 anymore. It's also slightly easier to create the pages locally (see question 1) but then pushing those to git hub is a bit trickier, so it depends on how comfortable the writer is with Terminal.
  5. We will be publishing 100+ articles - Is there a certain cadence we should follow when publishing new articles? Can we publish everything at once? Should we go hub-by-hub? It shouldn't really matter for the most part. I confess I haven't read through the whole doc. If a "hub" is like what's there right now - Split bills, request money, etc. - it might be good to make one PR first that creates those hubs, so that people only have to add the article pages rather than any folders. But once that's done it would be up to your own organization.
rushatgabhane commented 1 year ago

comment

dannymcclain commented 1 year ago

Here are the SVG icons for the category hubs.

helpdot category hub illustrations - svg.zip

Also here's a quick breakdown of the little category card spacing: image

Let me know if you need anything else, and here's the Figma file for good measure: Help site / Updated Home and Subpage Designs

maddylewis commented 1 year ago

@rushatgabhane - sent you an invite to Figma 👍

maddylewis commented 1 year ago

Associated GHs / to-do items (ongoing list)

melvin-bot[bot] commented 1 year ago

Reviewing label has been removed, please complete the "BugZero Checklist".

melvin-bot[bot] commented 1 year ago

The solution for this issue has been :rocket: deployed to production :rocket: in version 1.3.73-1 and is now subject to a 7-day regression period :calendar:. Here is the list of pull requests that resolve this issue:

If no regressions arise, payment will be issued on 2023-10-02. :confetti_ball:

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

For reference, here are some details about the assignees on this issue:

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

rushatgabhane commented 1 year ago

Created a manual request for $4k

https://staging.new.expensify.com/r/2691166635577186

@maddylewis could you please post a comment confirming that rushat should be paid $4k for this task? It's required for compliance i guess

melvin-bot[bot] commented 1 year ago

Triggered auto assignment to @chiragsalian, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

maddylewis commented 12 months ago

@rushatgabhane yes!

maddylewis commented 12 months ago

Payment due

additional details about payment here - https://expensify.slack.com/archives/C03TBKRSB/p1696254658408319?thread_ts=1693929579.915969&cid=C03TBKRSB

melvin-bot[bot] commented 12 months ago

Reviewing label has been removed, please complete the "BugZero Checklist".

melvin-bot[bot] commented 12 months ago

The solution for this issue has been :rocket: deployed to production :rocket: in version 1.3.75-12 and is now subject to a 7-day regression period :calendar:. Here is the list of pull requests that resolve this issue:

If no regressions arise, payment will be issued on 2023-10-09. :confetti_ball:

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

For reference, here are some details about the assignees on this issue:

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

maddylewis commented 12 months ago

i don't think there's any action for chirag on this one

melvin-bot[bot] commented 12 months ago

The solution for this issue has been :rocket: deployed to production :rocket: in version 1.3.76-6 and is now subject to a 7-day regression period :calendar:. Here is the list of pull requests that resolve this issue:

If no regressions arise, payment will be issued on 2023-10-10. :confetti_ball:

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

For reference, here are some details about the assignees on this issue:

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

maddylewis commented 12 months ago

updated bonus amount!

JmillsExpensify commented 11 months ago

@maddylewis Mind updating that summary? I think you have a typo with $5k

maddylewis commented 11 months ago

@JmillsExpensify - correct! updated (total = $6k -- $4k + $2k urgency bonus).

JmillsExpensify commented 11 months ago

$6,000 payment approved for @rushatgabhane based on BZ summary.

maddylewis commented 11 months ago

ill close this one out since we're no working out of our tidy-up tracking GH!