Skip to content

Update routes.yml - #13659

Merged
marcochavezf merged 1 commit into
mainfrom
johncschuster-patch-1
Dec 19, 2022
Merged

marcochavezf merged 1 commit into
mainfrom
johncschuster-patch-1

Conversation

@johncschuster

@johncschuster johncschuster commented Dec 16, 2022 •

Copy link
Copy Markdown
Contributor

We forgot to add the Everything-About-Chat article to the LHN navigation in this PR. This should fix it.

Details

A couple weeks ago, Maddy and I were exploring how to move an article from one hub to another using just the GH interface. That worked great, but we (I) forgot that we needed to update the navigation in the LHN to match where the article was going.

Per the docs:

_data: Contains custom global data, available anywhere via liquid with the syntax site.data.. Notably, there is a file called routes.yml in there which defines the structure of the app and metadata for its pages.

And under, Add the new page to routes.yml header:

Next, add the article to _data/routes.yml. Note that hubs contain one or more articles, which may or may not be grouped into sections with other related articles.

Fixed Issues

$ There was no GH to move the article from one hub to another.

Tests

Already tested locally #13659 (review)

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

  1. Open https://help.expensify.com/ (this is the production site for NewHelp, there's no staging server).
  2. Navigate to Other and verify the link to the Everything About Chat article appears in the LHN
  3. Click on Everything About Chat and verify the article is shown.
  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 correct English and 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
    • 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 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

We forgot to add the article to the LHN navigation in [this PR](#13272). This should fix it.
@johncschuster
johncschuster requested a review from a team as a code owner December 16, 2022 15:09
@melvin-bot
melvin-bot Bot requested review from dangrous and removed request for a team December 16, 2022 15:10
@melvin-bot

melvin-bot Bot commented Dec 16, 2022

Copy link
Copy Markdown

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

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

Looks good! I couldn't figure out how to test it locally but the code makes sense and matches the docs

@dangrous

Copy link
Copy Markdown
Contributor

@johncschuster can you check off the author checklist when you have a sec? I realize this doesn't affect the app so it's not necessary for review, but it IS necessary for the robots not to be mad at me when I merge haha

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

The change looks good, the Everything About Chat appears in the LHN:

Screen.Recording.2022-12-16.at.10.35.57.mov

@marcochavezf

marcochavezf commented Dec 19, 2022 •

Copy link
Copy Markdown
Contributor

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 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 correct English and 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 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 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.
  • 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

@marcochavezf

Copy link
Copy Markdown
Contributor

Completed the checklists to merge this minor fix that we need for the site.

@marcochavezf
marcochavezf merged commit aa16054 into main Dec 19, 2022
@marcochavezf
marcochavezf deleted the johncschuster-patch-1 branch December 19, 2022 20:08
@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@github-actions

Copy link
Copy Markdown
Contributor

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Duration
regularAppStart 0.016 ms → 0.015 ms (-0.002 ms, -9.5%)
nativeLaunch 10.250 ms → 9.677 ms (-0.573 ms, -5.6%)
runJsBundle 199.355 ms → 195.094 ms (-4.261 ms, -2.1%)
TTI 831.532 ms → 824.087 ms (-7.444 ms, -0.9%)
Show details
Name Duration
regularAppStart Baseline
Mean: 0.016 ms
Stdev: 0.001 ms (8.9%)
Runs: 0.01436399994418025 0.014405000023543835 0.014649000018835068 0.014770000008866191 0.014770000008866191 0.015177000081166625 0.01521899993531406 0.015339999925345182 0.015542999841272831 0.015544000081717968 0.0157880000770092 0.01582799991592765 0.015829000156372786 0.015868999995291233 0.015909999841824174 0.01599099999293685 0.016072000144049525 0.016112999990582466 0.016153999837115407 0.01615400006994605 0.01615400006994605 0.016195000149309635 0.016561000142246485 0.01680499967187643 0.01737500005401671 0.01782199996523559 0.017822999972850084 0.018432000186294317 0.019857000093907118 0.020671000005677342

Current
Mean: 0.015 ms
Stdev: 0.001 ms (7.2%)
Runs: 0.0125730000436306 0.013061000034213066 0.013590999878942966 0.013631999958306551 0.013794000260531902 0.013996999710798264 0.014037999790161848 0.014039000030606985 0.014119999948889017 0.014159999787807465 0.014161000028252602 0.014241999946534634 0.014281999785453081 0.014444999862462282 0.014526000246405602 0.014567000325769186 0.014607000164687634 0.014607999939471483 0.014689000323414803 0.014810999855399132 0.014811000321060419 0.014892000239342451 0.015542999841272831 0.015544000081717968 0.015584000386297703 0.015625 0.016398000065237284 0.0167239997535944 0.016764999832957983 0.017130999825894833
nativeLaunch Baseline
Mean: 10.250 ms
Stdev: 1.969 ms (19.2%)
Runs: 8 8 8 8 8 8 8 8 8 9 9 9 9 9 9 10 10 10 11 11 11 12 12 12 12 12 13 13 13 13 13 14

Current
Mean: 9.677 ms
Stdev: 1.711 ms (17.7%)
Runs: 8 8 8 8 8 8 8 9 9 9 9 9 9 9 9 9 9 9 9 9 10 10 10 10 11 11 11 13 13 14 14
runJsBundle Baseline
Mean: 199.355 ms
Stdev: 21.707 ms (10.9%)
Runs: 170 171 172 172 172 177 178 179 182 183 185 186 187 194 197 197 200 204 207 208 211 215 215 215 215 218 218 228 233 244 247

Current
Mean: 195.094 ms
Stdev: 21.334 ms (10.9%)
Runs: 168 171 172 173 173 173 174 174 175 180 181 182 182 186 188 188 191 193 193 198 202 204 205 209 212 216 221 221 223 232 237 246
TTI Baseline
Mean: 831.532 ms
Stdev: 33.387 ms (4.0%)
Runs: 760.266575000016 781.7356420001015 792.2953360001557 792.8353969999589 795.7959040000569 801.3494909999426 802.9089730000123 805.3445480000228 807.0033269999549 808.2140929999296 810.1441110000014 813.544608999975 816.5403040000238 822.0939309999812 835.3561770000961 835.8433159999549 835.869725999888 838.3420490000863 845.6714629998896 847.147796999896 848.8588819999713 849.9362570000812 853.684404999949 853.6858839998022 854.1715480000712 855.56831100001 866.9982599997893 868.9520280000288 874.0781290000305 886.1399330000859 917.1066499999724

Current
Mean: 824.087 ms
Stdev: 30.186 ms (3.7%)
Runs: 761.113601999823 769.7359230001457 786.7249759999104 787.8131420002319 788.2271790001541 791.8459149999544 800.4540260001086 805.4077039998956 806.1057469998486 806.4731189999729 810.0448280000128 811.6053829998709 814.1925909998827 814.9486790001392 822.5043350001797 826.3362819999456 828.7199559998699 830.5977460001595 841.5720790000632 841.7036640001461 842.4322080002166 842.7114380002022 847.9219200001098 850.6321849999949 857.5761629999615 859.7616349998862 860.5597850000486 863.8253990001976 869.9405129998922 881.1328259999864

@OSBotify OSBotify mentioned this pull request Dec 20, 2022
34 tasks done
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by @marcochavezf in version: 1.2.42-0 🚀

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

@mountiny

Copy link
Copy Markdown
Contributor

I will check this off from the list as this needs to be QAed in production

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by @yuwenmemon in version: 1.2.42-2 🚀

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.

5 participants