Skip to content

Expenses folder updates#39023

Closed
johncschuster wants to merge 17 commits intomainfrom
johncschuster-patch-2
Closed

Expenses folder updates#39023
johncschuster wants to merge 17 commits intomainfrom
johncschuster-patch-2

Conversation

@johncschuster
Copy link
Copy Markdown
Contributor

@johncschuster johncschuster commented Mar 26, 2024

Details

Expenses Category - https://help.expensify.com/expensify-classic/hubs/expenses/

Reports Subcategory

Create a Report

  • Move "Create a Report" to Reports Category
  • Delete resource after its moved
  • Add redirect link for Create a Report to X

Reimbursements

  • Move "Reimbursements" to Send Payments Category
  • Rename the article to something like "Reimburse Reports"
  • Delete original Reimbursements article
  • Add redirect link for Reimbursements to X

"Reports" subfolder

  • Delete Reports subfolder

Expenses Subcategory

  • Move to main Expenses Page (move the three resources out of the subcategory file so that they show on the main Expenses category page)
  • Delete "Add an Expense"
  • Add redirect link for Add an Expense X
  • Delete "Apply Tax"
  • Add redirect link for Apply Tax to X
  • Delete "Merge Expenses"
  • Add redirect link for Merge Expenses to X

"Expenses" subfolder

  • Delete Expenses subcategory folder that's nested under Expenses category 🙄

Referral Program

  • Delete from Expenses
  • Add redirect to X

Once your category is totally updated and beautiful

  • Make an announcement in Slack that this batch of resources is live on HelpDot (here's an example!)

Fixed Issues

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

QA Steps

Navigate to https://04c1fc59.helpdot.pages.dev/
Confirm the articles from the checklist above have been moved

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
      • 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/Videosundefined

Remove from `Expenses`
Publish under `Expensify Partner Program` folder
@johncschuster johncschuster marked this pull request as ready for review March 26, 2024 22:13
@johncschuster johncschuster requested a review from a team as a code owner March 26, 2024 22:13
@melvin-bot melvin-bot bot requested review from MonilBhavsar and removed request for a team March 26, 2024 22:13
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Mar 26, 2024

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

@johncschuster johncschuster requested review from rushatgabhane and removed request for MonilBhavsar March 26, 2024 22:17
@johncschuster johncschuster changed the title Rename Referral-Program.md to Referral-Program Move Referral Program article from Expenses hub to Expensify Partner Program hub Mar 27, 2024
@johncschuster johncschuster changed the title Move Referral Program article from Expenses hub to Expensify Partner Program hub Move Referral Program article from Expenses hub to Expensify Partner Program hub Mar 27, 2024
Copy link
Copy Markdown
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@johncschuster
Copy link
Copy Markdown
Contributor Author

Oh, whoops! Nice catch! Thanks for pointing that out!

@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Mar 28, 2024

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

@johncschuster
Copy link
Copy Markdown
Contributor Author

Just checked the preview above – looks good! 🙌

2024-04-01_10-40-17 2024-04-01_10-40-24 2024-04-01_10-40-28

@johncschuster
Copy link
Copy Markdown
Contributor Author

@rushatgabhane can I get another review when you get a moment?

…rt.md to docs/articles/expensify-classic/reports/Create-A-Report.md
@johncschuster johncschuster marked this pull request as draft April 3, 2024 16:12
@johncschuster johncschuster changed the title Move Referral Program article from Expenses hub to Expensify Partner Program hub Expenses folder updates Apr 3, 2024
@johncschuster johncschuster marked this pull request as ready for review April 3, 2024 18:31
Copy link
Copy Markdown
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

image

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 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 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(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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 4, 2024

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

NOTE: It looks like docs/redirects.csv was modified in this PR. Please see this SO for special instructions on how to review changes to that file.

@melvin-bot melvin-bot bot requested a review from grgia April 4, 2024 04:57
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 4, 2024

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

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

@johncschuster
Copy link
Copy Markdown
Contributor Author

@rushatgabhane I see I have some conflicts in the redirects.csv file. Can you guide me through how to fix those?

@rushatgabhane
Copy link
Copy Markdown
Member

Sure, gimme a moment

@rushatgabhane
Copy link
Copy Markdown
Member

This guide would help - https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github

@rushatgabhane
Copy link
Copy Markdown
Member

rushatgabhane commented Apr 4, 2024

Basically keep the changes that you want in the final state of the file redirect.csv

@johncschuster
Copy link
Copy Markdown
Contributor Author

Ok! I think I've got it sorted!

@grgia
Copy link
Copy Markdown
Contributor

grgia commented Apr 9, 2024

@johncschuster could you add QA steps for testing this to the description under QA

@grgia
Copy link
Copy Markdown
Contributor

grgia commented Apr 9, 2024

Have these tests failed for each run? hmm

@johncschuster
Copy link
Copy Markdown
Contributor Author

Sure thing, @grgia! I'll get some QA steps written shortly.

@johncschuster
Copy link
Copy Markdown
Contributor Author

johncschuster commented Apr 10, 2024

@grgia I've QA'd the issue by following this link (see my comment, here).

One thing to note, @caitlinwhite1 just put up this PR to bulk update the URL redirects, but I don't think my redirects have made it into that file.

@grgia / @rushatgabhane, it'll be important Caitlin's PR of the URL redirects does not get overwritten by my branch's version of the redirect's file. How do you recommend I get Caitlin's changes in my branch? Should I wait until Caitlin's PR is merged to main and then merge main into my file, or should I try something else?

@johncschuster
Copy link
Copy Markdown
Contributor Author

johncschuster commented Apr 11, 2024

In my head, I think I need to:

  1. wait for Caitlin's PR to be merged into main
  2. checkout and pull main, and merge main into my branch
  3. fix the redirects file
  4. submit my PR

Does that sound like a solid plan?

@rushatgabhane
Copy link
Copy Markdown
Member

rushatgabhane commented Apr 11, 2024

@johncschuster don't worry about Caitlin's PR. Whichever PR is merged later will have to resolve the conflicts

We'll merge this PR whenever it's ready

Copy link
Copy Markdown
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@johncschuster the hub send-payments does not exist. Could you please move the article Reimburse-reports somewhere else?

https://github.com/Expensify/App/blob/johncschuster-patch-2/docs/articles/expensify-classic/send-payments/Reimburse-reports.md

@johncschuster
Copy link
Copy Markdown
Contributor Author

Oh sure! I'll get that sorted shortly. Thanks, @rushatgabhane!

@johncschuster
Copy link
Copy Markdown
Contributor Author

Bumped in Slack for a bit of direction

@johncschuster
Copy link
Copy Markdown
Contributor Author

Ugh, I'm making a mess of this. I think I'm going to start over.

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.

5 participants