Update EYOC help doc and add new pages #26355

bondydaa · 2023-08-30T23:28:37Z

Creating new pages and updating content for the Expensify Your Own Conference (EYOC) pages.

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/311975
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

the EYOC main page:

Updates TOC with new links:

For Admins page:

For Attendees page:

For Speakers page:

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

bondydaa · 2023-08-30T23:29:25Z

Mostly ready for review, waiting on some updated content from the marketing team but let me know if there is anything glaringly wrong with the format of the files or something.

dangrous

One question and one very minor comment, but nothing looks weird or out of place! will hold on a final review for the final copy of course

dangrous · 2023-08-31T15:11:30Z

docs/articles/other/Expensify-Chat-For-Conference-Attendees.md

+- Share pictures of your travel before the event to hype everyone up, during the event if you met that person you’ve been meaning to see for years, or a fun pic from a party.
+- Try to create fun groups with your fellow attendees around common interests like touring a local sight, going for a morning run, or trying a famous restaurant.
+
+**Don't**


Suggested change

**Don't**

**Don't:**

dangrous · 2023-08-31T15:12:36Z

docs/articles/playbooks/Expensify-Chat-Playbook-for-Conferences.md

@@ -9,32 +9,32 @@ To help make setting up Expensify Chat for your event and your attendees super s

 ## Who you are



Does Jekyll cut down on extra spaces? This doc is formatted pretty differently to the other ones, with a lot more whitespace before/after section headers, etc.

that's a good question, i can't remember. I'll spin these up locally and get screenshots!

okay tested this out and i don't think it matters here is what it looks like

with this code

then if i throw in a bunch of extra new lines it doesn't change:

made sure to reload the page even though I have the live reload on as well and still the same.

melvin-bot · 2023-09-01T16:09:28Z

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

bondydaa · 2023-09-01T16:10:59Z

okay got this updated and tested locally finally.

I believe we're trying to get this out pretty quickly.

allroundexperts · 2023-09-01T16:11:46Z

On it @bondydaa

allroundexperts · 2023-09-01T16:12:53Z

Oh. Actually, do you need my review here @bondydaa since these are textual changes?

bondydaa · 2023-09-01T16:12:59Z

@allroundexperts could you just do the checklist? not sure there is much you can actually test though since this is the help doc site.

allroundexperts · 2023-09-01T16:13:16Z

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

…en footer

allroundexperts

Testing well!

melvin-bot · 2023-09-01T16:28:32Z

@aldo-expensify 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-09-01T16:28:36Z

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

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

bondydaa · 2023-09-01T16:29:24Z

ah looks like Daniel is OOO sick today. Going to see if I can get another set of eyes to approve and merge. going to dismiss his review since I fixed the one thing he called out.

addressed concern, daniel is OOO today.

bondydaa · 2023-09-01T16:30:30Z

oh neat i guess @aldo-expensify you're the lucky duck 😂

aldo-expensify

Left some NABS

aldo-expensify · 2023-09-01T17:27:21Z

docs/articles/playbooks/Expensify-Chat-Playbook-for-Conferences.md


 ### Step 2: Set up all the Expensify Chat rooms you want to feature at your event
-
-*Protip*: Your Expensify account manager can complete this step with you. Chat them in #admins on new.expensify.com to coordinate!
+**Protip**: Your Expensify account manager can complete this step with you. Chat them in #admins on new.expensify.com to coordinate!


Suggested change

**Protip**: Your Expensify account manager can complete this step with you. Chat them in #admins on new.expensify.com to coordinate!

**Protip**: Your Expensify account manager can complete this step with you. Chat them in #admins on [new.expensify.com](https://new.expensify.com) to coordinate!

NAB

NAB: Also, is "Chat them" phrased like that on purpose instead of "Chat with them"?

This was directly from the doc. https://docs.google.com/document/d/15OHoH9i9bipRTsEBi5Pud0m3TK3-i_jhv6emBvRrZqM/edit

cc @LLPeckham

aldo-expensify · 2023-09-01T17:32:53Z

docs/articles/playbooks/Expensify-Chat-Playbook-for-Conferences.md

+- Each hour, send a message listing exactly what is happening next – if there are multiple sessions happening simultaneously, list out each, along with a description of the session, a reminder of where it's located, and (most importantly) a link to the chat room for that session
+- Write the messages in [markdown format](https://help.expensify.com/articles/other/Everything-About-Chat#how-to-format-text), such that they can be copy/pasted directly into Expensify Chat for sending.
+  - If there is some formatting issue upon posting, no problem: just edit the comment after sending, and it'll be fixed for everyone.
+- We’d also recommend posting your updates on new lines so that if someone has a question about a certain item they can ask in a thread pertaining to that topic, rather than in one consolidated block.


Suggested change

- We’d also recommend posting your updates on new lines so that if someone has a question about a certain item they can ask in a thread pertaining to that topic, rather than in one consolidated block.

- We’d also recommend posting your updates on individual messages so that if someone has a question about a certain item they can ask in a thread pertaining to that topic, rather than in one consolidated block.

NAB: You can do many new lines in a single message and it won't allow you to create separate threads

aldo-expensify · 2023-09-01T17:34:18Z

docs/articles/playbooks/Expensify-Chat-Playbook-for-Conferences.md

+- [Expensify Chat for Conference Attendees](https://help.expensify.com/articles/other/Expensify-Chat-For-Conference-Attendees)
+- [Expensify Chat for Conference Speakers](https://help.expensify.com/articles/other/Expensify-Chat-For-Conference-Speakers)
+- [Expensify Chat for Admins](https://help.expensify.com/articles/other/Expensify-Chat-For-Admins)


These pages are not ready yet, right?

Out of the scope of this PR, but the not found page looks pretty broken

yeah we are adding these in this PR.

We could probably use relative URLs to make life easier but not a concern atm.

bondydaa · 2023-09-01T17:42:54Z

I'm going to merge this so the content is live and we can test.

we can easily make copy updates as needed.

aldo-expensify · 2023-09-01T17:43:57Z

Works for me!

OSBotify · 2023-09-01T17:47:55Z

✋ 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-09-01T23:37:20Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.62-0 🚀

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

OSBotify · 2023-09-04T16:22:02Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.62-4 🚀

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

dangrous · 2023-09-05T13:50:21Z

Thanks for the push on this! Sorry I was out for the end bit

bondydaa added 8 commits August 30, 2023 16:33

create 3 new pages for eyoc

5bf6523

fix file names

2f793ea

copying content from google doc

e504c30

cleaning up styles and comments

53ebdcb

copying heading styles from eyoc playbook

da718cc

copying content from google doc

e86915a

copying content from google doc

582366c

updating content per google doc

d9fde1e

bondydaa requested a review from dangrous August 30, 2023 23:28

bondydaa self-assigned this Aug 30, 2023

dangrous previously requested changes Aug 31, 2023

View reviewed changes

bondydaa added 2 commits August 31, 2023 15:11

update content per doc

fb74d1a

update content per doc

8f07f87

bondydaa marked this pull request as ready for review September 1, 2023 16:09

bondydaa requested a review from a team as a code owner September 1, 2023 16:09

melvin-bot bot removed the request for review from a team September 1, 2023 16:09

melvin-bot bot requested a review from allroundexperts September 1, 2023 16:09

add colon

7aea8a5

apparently empty new line at the bottom adds way too much space betwe…

5b19bac

…en footer

allroundexperts approved these changes Sep 1, 2023

View reviewed changes

melvin-bot bot requested a review from aldo-expensify September 1, 2023 16:28

melvin-bot bot mentioned this pull request Sep 1, 2023

Payment issue for E/App PR#26355 #26497

Closed

aldo-expensify approved these changes Sep 1, 2023

View reviewed changes

bondydaa merged commit 2fd54c1 into main Sep 1, 2023
17 checks passed

bondydaa deleted the bondy-eyoc-help-doc-updates branch September 1, 2023 17:43

OSBotify mentioned this pull request Sep 1, 2023

Deploy Checklist: New Expensify 2023-09-01 #26539

Closed

40 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update EYOC help doc and add new pages #26355

Update EYOC help doc and add new pages #26355

bondydaa commented Aug 30, 2023 •

edited

Loading

bondydaa commented Aug 30, 2023

dangrous left a comment

dangrous Aug 31, 2023

dangrous Aug 31, 2023 •

edited

Loading

bondydaa Aug 31, 2023

bondydaa Sep 1, 2023

melvin-bot bot commented Sep 1, 2023

bondydaa commented Sep 1, 2023

allroundexperts commented Sep 1, 2023

allroundexperts commented Sep 1, 2023

bondydaa commented Sep 1, 2023

allroundexperts commented Sep 1, 2023 •

edited

Loading

allroundexperts left a comment

melvin-bot bot commented Sep 1, 2023

melvin-bot bot commented Sep 1, 2023

bondydaa commented Sep 1, 2023

bondydaa commented Sep 1, 2023

aldo-expensify left a comment

aldo-expensify Sep 1, 2023

bondydaa Sep 1, 2023

aldo-expensify Sep 1, 2023

aldo-expensify Sep 1, 2023

aldo-expensify Sep 1, 2023

bondydaa Sep 1, 2023

bondydaa commented Sep 1, 2023

aldo-expensify commented Sep 1, 2023

OSBotify commented Sep 1, 2023

OSBotify commented Sep 1, 2023

OSBotify commented Sep 4, 2023

dangrous commented Sep 5, 2023

		@@ -9,32 +9,32 @@ To help make setting up Expensify Chat for your event and your attendees super s

		## Who you are

	Protip: Your Expensify account manager can complete this step with you. Chat them in #admins on new.expensify.com to coordinate!
	Protip: Your Expensify account manager can complete this step with you. Chat them in #admins on [new.expensify.com](https://new.expensify.com) to coordinate!

	- We’d also recommend posting your updates on new lines so that if someone has a question about a certain item they can ask in a thread pertaining to that topic, rather than in one consolidated block.
	- We’d also recommend posting your updates on individual messages so that if someone has a question about a certain item they can ask in a thread pertaining to that topic, rather than in one consolidated block.

Update EYOC help doc and add new pages #26355

Update EYOC help doc and add new pages #26355

Conversation

bondydaa commented Aug 30, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

bondydaa commented Aug 30, 2023

dangrous left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dangrous Aug 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 1, 2023

bondydaa commented Sep 1, 2023

allroundexperts commented Sep 1, 2023

allroundexperts commented Sep 1, 2023

bondydaa commented Sep 1, 2023

allroundexperts commented Sep 1, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 1, 2023

melvin-bot bot commented Sep 1, 2023

bondydaa commented Sep 1, 2023

bondydaa commented Sep 1, 2023

aldo-expensify left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bondydaa commented Sep 1, 2023

aldo-expensify commented Sep 1, 2023

OSBotify commented Sep 1, 2023

OSBotify commented Sep 1, 2023

OSBotify commented Sep 4, 2023

dangrous commented Sep 5, 2023

bondydaa commented Aug 30, 2023 •

edited

Loading

dangrous Aug 31, 2023 •

edited

Loading

allroundexperts commented Sep 1, 2023 •

edited

Loading