Update Auto-Reconciliation.md to add image/screenshot placeholder #29140

SofiedeVreese · 2023-10-10T01:40:11Z

Updating my Helpdot article to add images per https://stackoverflowteams.com/c/expensify/questions/17454/17455 to fix #28436

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Updating article to add image placeholder per https://stackoverflowteams.com/c/expensify/questions/17454/17455

melvin-bot · 2023-10-10T01:40:45Z

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

cloudflare-workers-and-pages · 2023-10-10T01:42:11Z

Deploying with Cloudflare Pages

Latest commit:	`9e54973`
Status:	✅ Deploy successful!
Preview URL:	https://22b0a28a.helpdot.pages.dev
Branch Preview URL:	https://sofiedevreese-patch-2.helpdot.pages.dev

View logs

nkuoch

Hmm..

Pretty sure that's not what you wanted?

SofiedeVreese · 2023-10-11T02:06:03Z

Yeah I think that's fine- I'm supposed to add a placeholder in there until my screenshots are ready! That way I can easily identify where my screenshots need to go!

nkuoch · 2023-10-11T22:51:16Z

Then let me know when it's ready and I'll merge it then?

SofiedeVreese · 2023-10-12T01:41:23Z

Yup that works- looks like my image upload is pending a review here.

nkuoch · 2023-10-16T20:19:41Z

I thinks the images a ready now?

Updating image placeholders with actual image URLs

OSBotify · 2023-10-22T23:14:15Z

A preview of your ExpensifyHelp changes have been deployed to https://head.helpdot.pages.dev ⚡️

SofiedeVreese · 2023-10-24T21:23:40Z

@nkuoch they are ready, yep! The preview linked above looks solid 👍 https://aabc3c71.helpdot.pages.dev/articles/expensify-classic/expensify-card/Auto-Reconciliation#gsc.tab=0

nkuoch · 2023-10-25T07:21:31Z

docs/articles/expensify-classic/expensify-card/Auto-Reconciliation.md

@@ -35,6 +35,8 @@ To set up your auto-reconciliation account with the Expensify Card, follow these
 5. Head to the "Settings" tab.
 6. Select the account in your accounting solution that you want to use for reconciliation. Make sure this account matches the settlement business bank account.

+![Insert alt text for accessibility here](https://help.expensify.com/assets/images/Auto-Reconciliaton_Image1.png){:width="100%"}


Can you replace all Insert alt text for accessibility here with a small image description?

Oh shoot, yes I can. Doing so now.

Hey @nkuoch is everything looking ok now?

Added alt text for Accessibility

nkuoch · 2023-10-31T07:25:08Z

docs/articles/expensify-classic/expensify-card/Auto-Reconciliation.md

@@ -35,6 +35,8 @@ To set up your auto-reconciliation account with the Expensify Card, follow these
 5. Head to the "Settings" tab.
 6. Select the account in your accounting solution that you want to use for reconciliation. Make sure this account matches the settlement business bank account.

+![Image showing overview of the Company Card Settings section](https://help.expensify.com/assets/images/Auto-Reconciliaton_Image1.png){:width="100%"}


No need for "Image showing overview of the ". Just keep the end of the sentence. (same for line 49)

Done- sorry for making this so painful 🙈

Removed the leading part of the sentence ("Image showing..", to just keep the description in there.

nkuoch · 2023-11-01T07:11:04Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2023-11-02T10:38:29Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.3.95-0 🚀

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

OSBotify · 2023-11-06T22:08:32Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀

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

OSBotify · 2023-11-06T22:35:52Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.3.96-0 🚀

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

OSBotify · 2023-11-09T22:53:25Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

Update Auto-Reconciliation.md

9e54973

Updating article to add image placeholder per https://stackoverflowteams.com/c/expensify/questions/17454/17455

SofiedeVreese self-assigned this Oct 10, 2023

SofiedeVreese requested a review from a team as a code owner October 10, 2023 01:40

melvin-bot bot requested review from nkuoch and removed request for a team October 10, 2023 01:40

nkuoch approved these changes Oct 10, 2023

View reviewed changes

nkuoch requested changes Oct 10, 2023

View reviewed changes

Update Auto-Reconciliation.md

4117624

Updating image placeholders with actual image URLs

nkuoch reviewed Oct 25, 2023

View reviewed changes

Update Auto-Reconciliation.md

692ab47

Added alt text for Accessibility

nkuoch reviewed Oct 31, 2023

View reviewed changes

Update Auto-Reconciliation.md

5f8ee37

Removed the leading part of the sentence ("Image showing..", to just keep the description in there.

nkuoch approved these changes Nov 1, 2023

View reviewed changes

nkuoch merged commit 26c2752 into main Nov 1, 2023
6 of 7 checks passed

nkuoch deleted the SofiedeVreese-patch-2 branch November 1, 2023 07:40

OSBotify mentioned this pull request Nov 2, 2023

Deploy Checklist: New Expensify 2023-11-02 #30752

Closed

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Auto-Reconciliation.md to add image/screenshot placeholder #29140

Update Auto-Reconciliation.md to add image/screenshot placeholder #29140

SofiedeVreese commented Oct 10, 2023 •

edited

Loading

melvin-bot bot commented Oct 10, 2023

cloudflare-workers-and-pages bot commented Oct 10, 2023

nkuoch left a comment

SofiedeVreese commented Oct 11, 2023

nkuoch commented Oct 11, 2023

SofiedeVreese commented Oct 12, 2023

nkuoch commented Oct 16, 2023

OSBotify commented Oct 22, 2023 •

edited

Loading

SofiedeVreese commented Oct 24, 2023

nkuoch Oct 25, 2023

SofiedeVreese Oct 25, 2023

SofiedeVreese Oct 30, 2023

nkuoch Oct 31, 2023

SofiedeVreese Oct 31, 2023

nkuoch commented Nov 1, 2023 •

edited

Loading

OSBotify commented Nov 2, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

Update Auto-Reconciliation.md to add image/screenshot placeholder #29140

Update Auto-Reconciliation.md to add image/screenshot placeholder #29140

Conversation

SofiedeVreese commented Oct 10, 2023 • edited Loading

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 10, 2023

cloudflare-workers-and-pages bot commented Oct 10, 2023

Deploying with Cloudflare Pages

nkuoch left a comment

Choose a reason for hiding this comment

SofiedeVreese commented Oct 11, 2023

nkuoch commented Oct 11, 2023

SofiedeVreese commented Oct 12, 2023

nkuoch commented Oct 16, 2023

OSBotify commented Oct 22, 2023 • edited Loading

SofiedeVreese commented Oct 24, 2023

nkuoch Oct 25, 2023

Choose a reason for hiding this comment

SofiedeVreese Oct 25, 2023

Choose a reason for hiding this comment

SofiedeVreese Oct 30, 2023

Choose a reason for hiding this comment

nkuoch Oct 31, 2023

Choose a reason for hiding this comment

SofiedeVreese Oct 31, 2023

Choose a reason for hiding this comment

nkuoch commented Nov 1, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Nov 2, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

SofiedeVreese commented Oct 10, 2023 •

edited

Loading

OSBotify commented Oct 22, 2023 •

edited

Loading

nkuoch commented Nov 1, 2023 •

edited

Loading