Moderation Help Article #22921

dangrous · 2023-07-14T21:16:17Z

@jliexpensify and @shawnborton please review for visuals and content!

Details

Adds info about moderation to our help docs

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/281503

Tests

None

Verify that no errors appear in the JS console

Offline tests

QA Steps

No QA

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-07-14T21:16:22Z

@eVoloshchak Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

dangrous · 2023-07-14T21:17:35Z

@jliexpensify I modified the screenshots slightly but I think this works. I also added one sentence to clarify that you get a whisper when you flag a piece of comment as well as if you are flagged.

Let me know what you think (screenshots in description)

Also @shawnborton lemme know if you see anything that you'd like to fix. Thanks!

jliexpensify · 2023-07-17T01:19:38Z

I think it looks good @dangrous - the only thing I noticed was the border around the phone:

@shawnborton might have some thoughts, but I personally think it's a little jarring - I think removing the shadow around the phone would look better.

Also, it looks like these corners are sharp, compared to the 4th which is rounded: does that need to be fixed?

dangrous · 2023-07-17T19:26:15Z

Ha yes those are my poor image combining skills - maybe @shawnborton would have a moment to fix them? The rounded vs. straight corners is simply because that one rounded one is an app edge, and the others are me cropping the screenshot.

There's probably a nicer way to do this

shawnborton · 2023-07-18T01:51:17Z

Yeah, it will be nice to standardize on how we mock up phone + chat room content. So perhaps I just need to get you a better mockup for this one and we can go from there?

dangrous · 2023-07-19T16:03:26Z

That would be lovely @shawnborton! Let me know if I can help at all.

Also to note - right now there isn't a super clean way in the code to put two images on the same line in the help docs, so that's why (you can see in the PR) I combined them into one. Another consideration for the mockups!

shawnborton · 2023-07-21T17:45:19Z

Cool, I can come up with a way to display both at the same time.

dangrous · 2023-07-26T15:56:11Z

Hey @shawnborton I know you're busy with a lot of other projects (and this is pretty lo pri) but lemme know when you've got the new assets and I can update!

shawnborton · 2023-07-27T11:35:38Z

My bad, I should be able to get this to you today!

shawnborton · 2023-07-27T23:16:42Z

Could something clean like this work?

jliexpensify · 2023-07-27T23:45:12Z

Looks great Shawn!

dangrous · 2023-07-28T14:34:19Z

That looks lovely!

dangrous · 2023-07-31T18:57:18Z

How do you feel about the other two images? One is a full screenshot (probably fine unless we want to crop or restyle?) and the other's another kinda bad double image.

jliexpensify · 2023-08-01T00:53:34Z

I think for consistency's sake, they should mirror what @shawnborton has done with the other images

shawnborton · 2023-08-01T11:51:39Z

Agree, happy to add the border to them so they look similar. Can you provide the raw screenshots and I can resize/adjust from there?

dangrous · 2023-08-01T16:00:14Z

Here are the two whisper screenshots:

And here's the Flag Comment page one, just in case:

shawnborton · 2023-08-01T16:18:07Z

Let me know if these work:

dangrous · 2023-08-02T13:49:14Z

Top one is lovely! For the bottom two, we're only really interested in the chat portion, or even - if we drill down more - the Concierge message itself. Would it make sense to crop those in even more?

shawnborton · 2023-08-02T14:06:03Z

Ah fair, something like this then?

dangrous · 2023-08-02T15:07:55Z

ah, perfect! I'll use these ones (unless GH downrezzes them but I don't think so?)

Thanks for the assist!

shawnborton · 2023-08-02T15:18:27Z

Give it a shot and let's see how it goes.

dangrous · 2023-08-02T18:34:30Z

Updated to use new images!

I also found a bug where in Firefox these images display way too large (cut off on the right) so I fixed that here and in the other page that uses large screenshots like this.

dangrous · 2023-08-04T14:33:11Z

Bump for review when you have a moment, @eVoloshchak!

eVoloshchak · 2023-08-07T17:33:57Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

eVoloshchak · 2023-08-07T17:59:14Z

@dangrous, are the images supposed to be visible on GitHub? Here's how it looks in browser and vscode preview

eVoloshchak · 2023-08-07T18:01:33Z

docs/articles/playbooks/Expensify-Playbook-for-Small-to-Medium-Sized-Businesses.md

@@ -100,7 +100,7 @@ This is essentially like setting a daily or individual expense limitation on any
 *Receipt Required Amount: $75*
 Receipts are important, and in most cases you prefer an itemized receipt. However, Expensify will generate an IRS-compliant electronic receipt (not itemized) for every expense not tied to hotels expense. For this reason, it’s important to enforce a rule where anytime an employee is on the road, and making business-related purchases at hotel (which happens a lot!), they are required to attach a physical receipt. 

-![Expense Basics](https://help.expensify.com/assets/images/playbook-expense-basics.png)
+![Expense Basics](https://help.expensify.com/assets/images/playbook-expense-basics.png){:width="100%"}


Both browser and vscode preview parse this incorrectly somehow

hm, just this one? Or all of them? If all of them, I think it may be a limitation of the markdown - vs. the actual jekyll server. Were you trying the server or just the markdown?

Or all of them?

It's all of them

Were you trying the server or just the markdown?

I'm just looking at how it looks in GitHub preview (example)

dangrous · 2023-08-07T21:01:13Z

@dangrous, are the images supposed to be visible on GitHub? Here's how it looks in browser and vscode preview

Yes sorry to test it you'll have to change it to http://localhost:4000/assets/images/moderation-context-menu.png or whatever your local version is hosted at. It can't pull the images from the real links yet because they don't exist!

eVoloshchak · 2023-08-07T21:41:49Z

it can't pull the images from the real links yet because they don't exist!

Ah, I see now, thank you!

dangrous · 2023-08-08T20:04:36Z

Let me know if you're still having trouble @eVoloshchak !

eVoloshchak · 2023-08-08T20:45:47Z

@dangrous, the GitHub preview is still displaying the width tag

Same for the preview in Vscode
What should I be using to test this?

dangrous · 2023-08-09T14:42:22Z

Yeah I don't think the markdown previews on their own will show correctly - you'll need to follow the instructions here to set it up locally - https://github.com/Expensify/App/blob/main/docs/README.md - (and then change those image URLS to http://localhost:4000). Let me know if that works!

eVoloshchak · 2023-08-10T11:46:32Z

@dangrous, thank you, all working and looking good now
Apologies for the delay, Jekyll turned out to be interesting to set up

melvin-bot · 2023-08-10T11:47:26Z

@MariaHCD Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

melvin-bot · 2023-08-10T11:47:30Z

🎯 @eVoloshchak, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #24362.

MariaHCD

LGTM! I noticed we didn't test on mobile, though. Is that something we can do?

dangrous · 2023-08-10T16:08:55Z

Ah good thought. Seems okay on a simulator!

MariaHCD · 2023-08-10T17:14:27Z

Hmm, the screenshots aren't super visible on mobile but I guess since the user can probably open up the image in a new tab, it should be fine? What do you think, @shawnborton?

shawnborton · 2023-08-10T18:03:21Z

Yeah, I think that's probably okay? Or we can change up the asset or serve up different assets for mobile entirely?

shawnborton · 2023-08-10T18:03:33Z

I also don't mind just getting this out and optimizing at a later date.

MariaHCD

LGTM! I'm on board with optimizing for mobile later.

OSBotify · 2023-08-11T06:18:26Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-08-14T20:04:46Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.3.54-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-08-14T21:05:02Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.3.54-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-08-17T02:55:38Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.54-13 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

dangrous added 3 commits July 14, 2023 15:42

add text

21f2e6c

add images

9428500

update URLs

9a9cb73

dangrous requested a review from a team as a code owner July 14, 2023 21:16

melvin-bot bot removed the request for review from a team July 14, 2023 21:16

dangrous self-assigned this Jul 14, 2023

melvin-bot bot requested a review from eVoloshchak July 14, 2023 21:16

dangrous changed the title ~~Moderation Help Article~~ [Hold for design/marketing approval] Moderation Help Article Jul 14, 2023

Merge branch 'main' into dangrous-moderationhelptext

cdbca28

dangrous changed the title ~~[Hold for design/marketing approval] Moderation Help Article~~ Moderation Help Article Aug 2, 2023

eVoloshchak reviewed Aug 7, 2023

View reviewed changes

eVoloshchak approved these changes Aug 10, 2023

View reviewed changes

melvin-bot bot requested a review from MariaHCD August 10, 2023 11:47

melvin-bot bot mentioned this pull request Aug 10, 2023

[Awaiting Payment 24th August] Payment issue for E/App PR#22921 #24362

Closed

MariaHCD reviewed Aug 10, 2023

View reviewed changes

MariaHCD approved these changes Aug 11, 2023

View reviewed changes

MariaHCD merged commit dd0d98f into main Aug 11, 2023
16 of 19 checks passed

MariaHCD deleted the dangrous-moderationhelptext branch August 11, 2023 06:14

OSBotify mentioned this pull request Aug 14, 2023

Deploy Checklist: New Expensify 2023-08-14 #24550

Closed

49 tasks

Moderation Help Article #22921

Moderation Help Article #22921

Conversation

dangrous commented Jul 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 14, 2023

dangrous commented Jul 14, 2023

jliexpensify commented Jul 17, 2023

dangrous commented Jul 17, 2023

shawnborton commented Jul 18, 2023

dangrous commented Jul 19, 2023 • edited Loading

shawnborton commented Jul 21, 2023

dangrous commented Jul 26, 2023

shawnborton commented Jul 27, 2023

shawnborton commented Jul 27, 2023

jliexpensify commented Jul 27, 2023

dangrous commented Jul 28, 2023

dangrous commented Jul 31, 2023

jliexpensify commented Aug 1, 2023

shawnborton commented Aug 1, 2023

dangrous commented Aug 1, 2023

shawnborton commented Aug 1, 2023

dangrous commented Aug 2, 2023

shawnborton commented Aug 2, 2023 • edited Loading

dangrous commented Aug 2, 2023

shawnborton commented Aug 2, 2023

dangrous commented Aug 2, 2023

dangrous commented Aug 4, 2023

eVoloshchak commented Aug 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak commented Aug 7, 2023 • edited Loading

eVoloshchak Aug 7, 2023

Choose a reason for hiding this comment

dangrous Aug 7, 2023

Choose a reason for hiding this comment

eVoloshchak Aug 7, 2023

Choose a reason for hiding this comment

dangrous commented Aug 7, 2023

eVoloshchak commented Aug 7, 2023 • edited Loading

dangrous commented Aug 8, 2023

eVoloshchak commented Aug 8, 2023 • edited Loading

dangrous commented Aug 9, 2023

eVoloshchak commented Aug 10, 2023

melvin-bot bot commented Aug 10, 2023

melvin-bot bot commented Aug 10, 2023

MariaHCD left a comment

Choose a reason for hiding this comment

dangrous commented Aug 10, 2023

MariaHCD commented Aug 10, 2023

shawnborton commented Aug 10, 2023

shawnborton commented Aug 10, 2023

MariaHCD left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 11, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 14, 2023

OSBotify commented Aug 17, 2023

dangrous commented Jul 14, 2023 •

edited

Loading

dangrous commented Jul 19, 2023 •

edited

Loading

shawnborton commented Aug 2, 2023 •

edited

Loading

eVoloshchak commented Aug 7, 2023 •

edited

Loading

eVoloshchak commented Aug 7, 2023 •

edited

Loading

eVoloshchak commented Aug 7, 2023 •

edited

Loading

eVoloshchak commented Aug 8, 2023 •

edited

Loading