Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and rename pay-an-invoice.md to Pay-an-invoice.md #48367

Merged
merged 3 commits into from
Sep 3, 2024

Conversation

Christinadobrzyn
Copy link
Contributor

Trying to fix the formatting of the current article. I removed something that I think doesn't need to be included in the desktop and mobile section.

I also capitalized the "Pay-an Invoice" article name.

Details

This help article formatting is wrong:

image

I think it's because of this paragraph that should be outside the mobile and desktop steps. So I've moved it.

I also capitalized "P" in Pay an Invoice.

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
    • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Trying to fix the formatting of the current article. I removed something that I think doesn't need to be included in the desktop and mobile section. 

I also capitalized the "Pay-an Invoice" article name.
@Christinadobrzyn Christinadobrzyn requested a review from a team as a code owner August 30, 2024 20:42
@melvin-bot melvin-bot bot requested review from lakchote and removed request for a team August 30, 2024 20:43
Copy link

melvin-bot bot commented Aug 30, 2024

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

Adding a new section to the article. I'm also trying to fix the bullets at the top fo the page. They shouldn't have a space between them.
@lakchote
Copy link
Contributor

lakchote commented Sep 2, 2024

QA Steps

  • Verify that no errors appear in the JS console

Same as in tests

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 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

image

MacOS: Desktop

lakchote
lakchote previously approved these changes Sep 2, 2024
Copy link
Contributor

@lakchote lakchote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@blimpich
Copy link
Contributor

blimpich commented Sep 3, 2024

It would be nice if we could get the Deploy ExpensifyHelp check going green so we could actually test to see if this worked. This is the error for why is failed:

Screenshot 2024-09-03 at 9 49 44 AM

@blimpich
Copy link
Contributor

blimpich commented Sep 3, 2024

I imagine that is because we changed the lower case p to a capital p, can we update the redirects.csv file to redirect from a lower case p to a upper case p version of the article? That way the deploy script will work and we should be able to check to see if these changes did in fact fix this.

@Christinadobrzyn
Copy link
Contributor Author

Hi there! yes I updated the name of the article to an uppercase 'P'. Just a heads up that I'm going to be ooo 9/4-9/10. I'll try to keep an eye on this while I'm gone but let me know if there's anything I can do today.

@blimpich
Copy link
Contributor

blimpich commented Sep 3, 2024

@Christinadobrzyn can you update this file to redirect from a lowercase version of the file your renamed to a upper case version? That seems to be what is causing that error I posted a screenshot of

@Christinadobrzyn
Copy link
Contributor Author

I don't see "https://help.expensify.com/articles/new-expensify/expenses-&-payments/pay-an-invoice" or "pay-an-invoice" here - https://github.com/Expensify/App/blob/main/docs/redirects.csv

It's just the title of the article that needs to change -
image

Here is the SO to update the title of an article, which I believe I followed when creating this GH. Should I create another PR?

@blimpich
Copy link
Contributor

blimpich commented Sep 3, 2024

Did you follow step 4 of that SO? It says that we need a redirect link if we updated the title of a article.

@blimpich
Copy link
Contributor

blimpich commented Sep 3, 2024

You'll need to add a new redirect to that file if it doesn't already exist.

@Christinadobrzyn
Copy link
Contributor Author

Christinadobrzyn commented Sep 3, 2024

Ah, okay, no I didn't do Step 4. Sorry! I added it now and created a new PR linked to this. Hopefully that will help! So sorry!

@OSBotify
Copy link
Contributor

OSBotify commented Sep 3, 2024

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

@blimpich
Copy link
Contributor

blimpich commented Sep 3, 2024

Sweet looks like it deployed a preview of the changes. @Christinadobrzyn does this look correct?
Screenshot 2024-09-03 at 12 37 22 PM

@Christinadobrzyn
Copy link
Contributor Author

yes! that does look correct! yay thank you @blimpich!

@blimpich blimpich merged commit 3d026d5 into main Sep 3, 2024
8 of 10 checks passed
@blimpich blimpich deleted the christina-branch9 branch September 3, 2024 19:46
@blimpich
Copy link
Contributor

blimpich commented Sep 3, 2024

No problem! 👍

@OSBotify
Copy link
Contributor

OSBotify commented Sep 3, 2024

🚀 Deployed to staging by https://github.com/blimpich in version: 9.0.29-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 5, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.29-12 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants