Skip to content

Fixing Pay Invoice and Send Invoice articles #48012

Closed
Christinadobrzyn wants to merge 3 commits into
mainfrom
christina-patch8
Closed

Fixing Pay Invoice and Send Invoice articles #48012
Christinadobrzyn wants to merge 3 commits into
mainfrom
christina-patch8

Conversation

@Christinadobrzyn

Copy link
Copy Markdown
Contributor

Details

These two articles look bad:

https://help.expensify.com/articles/new-expensify/expenses-&-payments/pay-an-invoice
https://help.expensify.com/articles/new-expensify/expenses-&-payments/Send-an-invoice

I'm hoping this PR will fix them. Per this Slack convo I added "{% include end-selector.html %}" below the mobile and desktop sections.

Fixed Issues

Hopefully I fixed the formatting issue so that the article looks correct. See screenshots below of what it currently looks like.

I think there will probably be other things that need to be fixed - it looks like the links are working but if we can at least fix the formatting then I can figure out what else needs to be fixed.

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

Screenshots/Videos

image image

trying to fix an issue that's breaking the article format
Trying to fix a formatting issue that's breaking the article. Added "{% include end-selector.html %}" below the Mobile and Desktop settings
@Christinadobrzyn Christinadobrzyn requested a review from a team as a code owner August 26, 2024 15:47
@Christinadobrzyn Christinadobrzyn self-assigned this Aug 26, 2024
@melvin-bot melvin-bot Bot requested a review from blimpich August 26, 2024 15:47
@Christinadobrzyn Christinadobrzyn requested review from rushatgabhane and removed request for blimpich August 26, 2024 15:47
@melvin-bot melvin-bot Bot requested review from blimpich and removed request for a team and rushatgabhane August 26, 2024 15:47
@melvin-bot

melvin-bot Bot commented Aug 26, 2024

Copy link
Copy Markdown

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

@OSBotify

OSBotify commented Aug 26, 2024

Copy link
Copy Markdown
Contributor

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

@blimpich

Copy link
Copy Markdown
Contributor

@Christinadobrzyn can you confirm using the preview of your changes that this looks the way you expect it to?

@Christinadobrzyn

Christinadobrzyn commented Aug 26, 2024

Copy link
Copy Markdown
Contributor Author

@blimpich thanks for referencing the preview, no it doesn't look right. Everything is grouped by the mobile or desktop. should I create a new PR to try and fix this? The article should look like this: https://8a741651.helpdot.pages.dev/articles/new-expensify/expenses-&-payments/Create-an-expense

This is the draft of what is should look like

@blimpich

Copy link
Copy Markdown
Contributor

Ah I see, lemme take a look at it for a minute and see if I can figure out why it looks so wonky

Update a formatting issue at the top of the article- checked preview and it looks right.

@blimpich blimpich left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Okay I think I understand. @Christinadobrzyn I think what @rushatgabhane meant by this comment is that we are missing a {% include end-selector.html %} from the document. This PR does that but it also removes multiple {% include end-option.html %}.

They are basically acting like HTML tags, so for every time {% include selector.html values="desktop, mobile" %} shows up that means that there needs to be a corresponding {% include end-selector.html %} below it to act as a kind of closing tag. Sort of like Russian nesting dolls.

@Christinadobrzyn can you go through these documents again and make sure that your changes are simply adding the missing {% include end-selector.html %}? Your changes to the end-option tags I think are breaking more things.

4. Tap **More features**.
5. Under the Earn section, enable the Invoice toggle.

{% include end-option.html %}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Lets not delete this.


{% include info.html %}
Anyone who receives an Expensify invoice can pay it using Expensify—even if they don’t have an Expensify account.
{% include end-info.html %}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we should delete this.

2. Click **Pay**.
3. Choose **Pay as an individual** or **Pay as a business**.
4. Click **Add Bank Account** or **Add debit or credit card** to issue payment.
{% include end-option.html %}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same here, don't think this should be deleted.

2. Tap **Pay**.
3. Choose **Pay as an individual** or **Pay as a business**.
4. Tap **Add Bank Account** or **Add debit or credit card** to issue payment.
{% include end-option.html %}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No delete here too.

@blimpich

blimpich commented Aug 26, 2024

Copy link
Copy Markdown
Contributor

And if its easier for you just create a new PR with your changes and add me as the reviewer 👍

Christinadobrzyn added a commit that referenced this pull request Aug 26, 2024
Creating a new PR based on discussions here - #48012
Christinadobrzyn added a commit that referenced this pull request Aug 26, 2024
Creating a new PR based on this discussion #48012
@Christinadobrzyn

Copy link
Copy Markdown
Contributor Author

Okay, I created a new PR - #48022 If you can take a peek. TY!

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.

3 participants