Create Expensify-Chat-Playbook-for-Conferences by MitchExpensify · Pull Request #22369 · Expensify/App

MitchExpensify · 2023-07-06T19:17:10Z

Details

Add the new article Expensify Playbook for Conferences

Fixed Issues

PROPOSAL: https://github.com/Expensify/Expensify/issues/290084

Tests

Run the help site, navigate to the Playbooks hub, and click on Expensify Chat Playbook for Conferences
Verify the content of the article is shown.

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

NA

For example:

Click on the text input to bring it into focus
Upload an image via copy paste
Verify a modal appears displaying a preview of that image
--->

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

Screen.Recording.2023-02-21.at.16.47.31.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-07-06T19:17:16Z

@Santhosh-Sellavel 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]

github-actions · 2023-07-06T19:17:24Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

MitchExpensify · 2023-07-06T19:19:07Z

Thanks @Santhosh-Sellavel ! The preview function wasn't helping me here so I'm curious if these changes look aligned with other playbooks e.g. here https://help.expensify.com/articles/playbooks/Expensify-Playbook-for-Small-to-Medium-Sized-Businesses

Santhosh-Sellavel · 2023-07-06T19:24:54Z

Let me check

Santhosh-Sellavel · 2023-07-06T19:33:31Z

@MitchExpensify Looks good so far, check the comparison below

Screen.Recording.2023-07-07.at.1.01.40.AM.mov

MitchExpensify · 2023-07-06T22:22:06Z

Thanks @Santhosh-Sellavel ! Thats weird that most of the content seems to be missing

MitchExpensify · 2023-07-06T22:24:00Z

Do we need to remove "< !--" and "- ->" from each section so the content shows?

MitchExpensify · 2023-07-06T22:26:07Z

Basically there is copy under each header that doesn't appear to be showing. Here's some of the draft for reference

Santhosh-Sellavel · 2023-07-06T22:32:40Z

@MitchExpensify

Do we need to remove "< !--" and "- ->" from each section so the content shows?

That's the syntax for commenting in markdown, those comments are not visible in the preview!

Here is this is how it looks now, after removing it

Screen.Recording.2023-07-07.at.4.00.27.AM.mov

MitchExpensify · 2023-07-06T22:36:28Z

Nice! Ok that looks great

Santhosh-Sellavel · 2023-07-06T22:37:05Z

Here is the file content.md

MitchExpensify · 2023-07-06T22:48:20Z

Looks good to me @Santhosh-Sellavel !

Santhosh-Sellavel · 2023-07-06T23:00:31Z

Please make the changes, seems it's not done yet!

MitchExpensify · 2023-07-06T23:34:23Z

I think I made the necessary changes @Santhosh-Sellavel

MitchExpensify · 2023-07-07T17:03:08Z

What are the next steps here @Santhosh-Sellavel ?

Santhosh-Sellavel · 2023-07-07T18:08:26Z

@MitchExpensify
The next step update the PR description i.e. complete the checklist and add test steps. Here is an example PR

Santhosh-Sellavel · 2023-07-07T18:09:26Z

Or

CLA Assistant Lite bot: Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

I have read the CLA Document and I hereby sign the CLA

You can retrigger this bot by commenting recheck in this Pull Request

@MitchExpensify You didn't sign this please do that!

MitchExpensify · 2023-07-07T18:15:17Z

I have read the CLA Document and I hereby sign the CLA

MitchExpensify · 2023-07-07T18:19:05Z

The next step update the PR description i.e. complete the checklist and add test steps

Done! Thanks

Santhosh-Sellavel · 2023-07-07T18:23:48Z

@MitchExpensify You can delete this unnecessary text

Also Add [No QA] to title

Santhosh-Sellavel · 2023-07-07T18:28:24Z

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 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

Screen.Recording.2023-07-07.at.4.00.27.AM.mov

Santhosh-Sellavel · 2023-07-07T18:33:05Z

@MitchExpensify

Need to update the routes.yml as the PR does. Then we should be good to go!

Santhosh-Sellavel · 2023-07-07T18:37:27Z

Seems like we may not need to update, as I don't see any existing article references also. So let's get an engineer to move this forward

Santhosh-Sellavel

LGTM!

melvin-bot · 2023-07-07T18:38:14Z

@chiragsalian 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]

MitchExpensify · 2023-07-07T19:34:45Z

https://help.expensify.com/hubs/playbooks

Do we need to do anything additional to get this playbook to appear just like the others in terms of being listed here and here?

Santhosh-Sellavel · 2023-07-07T20:46:03Z

No, we don't need to do anything

Santhosh-Sellavel · 2023-07-07T20:47:37Z

@MitchExpensify You have to save it with externsion .md

Expensify-Chat-Playbook-for-Conferences.md

Santhosh-Sellavel · 2023-07-07T20:49:59Z

That is the problem why your preview was not working on git

Santhosh-Sellavel · 2023-07-07T20:55:00Z

Here is the recording @MitchExpensify, that confirms this works

Screen.Recording.2023-07-08.at.2.23.40.AM.mov

chiragsalian · 2023-07-07T20:59:52Z

yup what santhosh said. Also looks like you've got travis errors to address. Let me know if you need any help with it.

MitchExpensify · 2023-07-10T15:56:26Z

Ok that looks great!

@chiragsalian yes if you could help me address the Travis errors that'd be great! Thank you

…book-for-Conferences.md

OSBotify · 2023-07-10T19:04:34Z

✋ 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-07-11T00:19:25Z

🚀 Deployed to staging by https://github.com/MitchExpensify in version: 1.3.39-0 🚀

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

OSBotify · 2023-07-13T01:43:27Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.39-11 🚀

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

MitchExpensify · 2023-07-13T15:41:01Z

This hit prod but I don't see it on https://help.expensify.com/hubs/playbooks

MitchExpensify · 2023-07-13T16:20:28Z

@francoisl @Santhosh-Sellavel Any idea why this isn't showing on production?

MitchExpensify · 2023-07-13T16:20:59Z

Will issue payment to @Santhosh-Sellavel via NewDot - $500 seems fair to us both 👍

Santhosh-Sellavel · 2023-07-13T16:28:20Z

Seems Deployment failed for help docs https://github.com/Expensify/App/actions/workflows/deployExpensifyHelp.yml

MitchExpensify · 2023-07-13T23:20:39Z

Cool, what do we need to do to get this live?

francoisl · 2023-07-13T23:27:23Z

I haven't had time to look into this today yet, I set myself a reminder to check after the next deploy.

MitchExpensify · 2023-07-13T23:37:49Z

Thank you! We are keen to get this over to CallStack asap because its part of the plan to have them use Expensify Chat for React Europe 🙇

francoisl · 2023-07-13T23:47:31Z

Done - see https://help.expensify.com/articles/playbooks/Expensify-Chat-Playbook-for-Conferences

I had to cancel this old workflow that was stuck running for 15 days, and then I manually restarted the deployExpensifyHelp.yml workflow.

MitchExpensify · 2023-07-14T19:41:53Z

Awesome!, thanks @francoisl

francoisl · 2023-07-14T20:15:20Z

+### Step 3: Add chat room QR codes to the applicable session slide deck
+
+Gather QR codes:
+1. Go to new.exensify.com 


This one says exensify - opened a quick PR here. Directly assigned you @chiragsalian since you already have context.

anmurali · 2023-07-18T18:07:12Z

Approved $500 to Santhosh on ND

Create Expensify-Chat-Playbook-for-Conferences

453ce32

MitchExpensify requested a review from a team as a code owner July 6, 2023 19:17

melvin-bot Bot requested review from Santhosh-Sellavel and removed request for a team July 6, 2023 19:17

Update Expensify-Chat-Playbook-for-Conferences

ca4b0f1

Santhosh-Sellavel approved these changes Jul 7, 2023

View reviewed changes

melvin-bot Bot requested a review from chiragsalian July 7, 2023 18:38

Rename Expensify-Chat-Playbook-for-Conferences to Expensify-Chat-Play…

130e923

…book-for-Conferences.md

chiragsalian approved these changes Jul 10, 2023

View reviewed changes

MitchExpensify merged commit 0bdca70 into main Jul 10, 2023

MitchExpensify deleted the MitchExpensify-patch-1 branch July 10, 2023 18:55

OSBotify mentioned this pull request Jul 10, 2023

Deploy Checklist: New Expensify 2023-07-10 #22598

Closed

76 tasks

lanitochka17 mentioned this pull request Jul 11, 2023

Help- Expensify chat playbook for conferences not displayed #22682

Closed

6 tasks

francoisl mentioned this pull request Jul 14, 2023

[HelpSite] Fix typo in link, make it clickable #22917

Merged

58 tasks

francoisl reviewed Jul 14, 2023

View reviewed changes

Conversation

MitchExpensify commented Jul 6, 2023 • edited by chiragsalian Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jul 6, 2023

Uh oh!

github-actions Bot commented Jul 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MitchExpensify commented Jul 6, 2023

Uh oh!

Santhosh-Sellavel commented Jul 6, 2023

Uh oh!

Santhosh-Sellavel commented Jul 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MitchExpensify commented Jul 6, 2023

Uh oh!

MitchExpensify commented Jul 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MitchExpensify commented Jul 6, 2023

Uh oh!

Santhosh-Sellavel commented Jul 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MitchExpensify commented Jul 6, 2023

Uh oh!

Santhosh-Sellavel commented Jul 6, 2023

Uh oh!

MitchExpensify commented Jul 6, 2023

Uh oh!

Santhosh-Sellavel commented Jul 6, 2023

Uh oh!

MitchExpensify commented Jul 6, 2023

Uh oh!

MitchExpensify commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Uh oh!

MitchExpensify commented Jul 7, 2023

Uh oh!

MitchExpensify commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Jul 7, 2023

Uh oh!

MitchExpensify commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Santhosh-Sellavel commented Jul 7, 2023

Uh oh!

MitchExpensify commented Jul 6, 2023 •

edited by chiragsalian

Loading

github-actions Bot commented Jul 6, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 6, 2023 •

edited

Loading

MitchExpensify commented Jul 6, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 6, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 7, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 7, 2023 •

edited

Loading

MitchExpensify commented Jul 13, 2023 •

edited

Loading

Santhosh-Sellavel commented Jul 13, 2023 •

edited

Loading