[HelpDot] New structure to support platforms #27851

rushatgabhane · 2023-09-20T10:26:47Z

Details

This is a massive PR, but most files are dummy Coming Soon files.
For the review you'll want to focus on the following files:

docs/_data/_routes.yml - Contains 2 platforms and 12 hubs inside each platform. This will be used by createDocsRoutes to generate the routes.yml file used for defining title, description, icon path etc for navigation and the UI.
.github/scripts/createDocsRoutes.js - Adds all the articles and sections defined in docs/articles to routes.yml
docs/expensify-classic/hubs/ - Contains 12 hubs for expensify classic
docs/new-expensify/hubs/ - Contains 12 hubs for new expensify

Fixed Issues

$ #27150
PROPOSAL: N.A.

Tests

run npm run createDocsRoutes
Open docs/_data/routes.yml.

Verify that the structure generated resembles this doc

Verify that it has home and a description for it.
Verify that it has two platforms (expensify-classic and new-expensify)
Verify that bank-accounts-and-credit-cards has articles inside it.
Verify that bank-accounts-and-credit-cards for expensify-classic has a section, and articles inside it.

Verify that removing/adding hubs throws an error on running `createDocsRoutes`

Remove from _routes.yml
i. Remove a hub from docs/_data/_routes.yml eg: integrations
ii. Verify that npm run createDocsRoutes throws an error.
Delete from docs/new-expensify/
i. Delete docs/new-expensify/account-settings.html
ii. Verify that npm run createDocsRoutes throws an error.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that https://help.expensify.com/#gsc.tab=0 is still working.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

N.A.

melvin-bot · 2023-09-20T15:21:52Z

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

s77rt · 2023-09-20T21:22:01Z

.github/scripts/createDocsRoutes.js

-    process.exit(1);
+    return 1;


Revert. return 1 is not the program exit code. It still exists with code 0.

nice catch. is this a javascript thing?

Yeah I think so

.github/scripts/createDocsRoutes.js

s77rt · 2023-09-20T21:40:22Z

docs/new-expensify/hubs/index.html

+title: New Expensify
+---
+
+{% include platform.html %}


_includes/ does not have platform.html file

This is done to make it easier for review.
It'll be added in next PRs!

Deployment of help site is paused, so it won't break anything

This breaks local testing though 😅 I hope the new PR lands soon

yes, let's get this one merged asap

s77rt · 2023-09-20T23:39:07Z

Verify that bank-accounts-and-credit-cards has a section, and articles inside it.

In new expensify there is no section

rushatgabhane · 2023-09-21T08:31:33Z

In new expensify there is no section

@s77rt updated the step to mention it's applicable for expensify-classic only

roryabraham

Since:

there's no way to test this locally (until @rushatgabhane created follow-up PR)
HelpDot deploys are disabled
The code seems fine

I don't think it makes sense to delay here. Going to merge this.

roryabraham · 2023-09-21T09:52:05Z

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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2023-09-21T09:59:34Z

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

OSBotify · 2023-09-22T14:00:05Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:34:56Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:06:57Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:49:18Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

rushatgabhane added 6 commits September 20, 2023 15:49

delete existing routes

5b2e89c

delete existing hubs

3ef926c

delete existing articles

08ebea7

delete existing articles

8a3f829

delete existing articles

fcb7bd0

delete existing articles

97d4b24

rushatgabhane changed the title ~~Rush help dot~~ [HelpDot] New structure to support platforms Sep 20, 2023

rushatgabhane added 10 commits September 20, 2023 16:41

add routes for new hubs and platforms

575948c

add platforms and hubs to routes using script

63fa6e2

change variablename

aa6972b

refactor

2309991

fix: improve readability

fe063d5

add expensify classic hubs

ce58e36

add new expensify hubs

2a3e8ea

add expensify classic articles

85d8a0b

add new expensify articles

c00f4e4

add coming soon articles for new expensify

09266be

rushatgabhane marked this pull request as ready for review September 20, 2023 15:21

rushatgabhane requested a review from a team as a code owner September 20, 2023 15:21

melvin-bot bot requested review from s77rt and removed request for a team September 20, 2023 15:21

rushatgabhane added 3 commits September 20, 2023 20:56

fix lint

247055e

fix lint

7cf684d

rename

4909cb2

s77rt suggested changes Sep 20, 2023

View reviewed changes

rushatgabhane added 2 commits September 21, 2023 04:50

replace return with exit()

8a6d44c

fix lint

ed0267c

rushatgabhane requested a review from s77rt September 21, 2023 08:34

roryabraham approved these changes Sep 21, 2023

View reviewed changes

roryabraham merged commit 25cc70c into Expensify:main Sep 21, 2023
15 of 18 checks passed

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

melvin-bot bot mentioned this pull request Sep 25, 2023

Community Migration to HelpDot - C+ Assistance #27150

Closed

9 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HelpDot] New structure to support platforms #27851

[HelpDot] New structure to support platforms #27851

rushatgabhane commented Sep 20, 2023 •

edited

Loading

melvin-bot bot commented Sep 20, 2023

s77rt Sep 20, 2023

rushatgabhane Sep 20, 2023

s77rt Sep 20, 2023

s77rt Sep 20, 2023 •

edited

Loading

rushatgabhane Sep 20, 2023 •

edited

Loading

s77rt Sep 20, 2023

rushatgabhane Sep 21, 2023

s77rt commented Sep 20, 2023 •

edited

Loading

rushatgabhane commented Sep 21, 2023

roryabraham left a comment

roryabraham commented Sep 21, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

[HelpDot] New structure to support platforms #27851

[HelpDot] New structure to support platforms #27851

Conversation

rushatgabhane commented Sep 20, 2023 • edited Loading

Details

Fixed Issues

Tests

Verify that the structure generated resembles this doc

Verify that removing/adding hubs throws an error on running createDocsRoutes

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 20, 2023

s77rt Sep 20, 2023

Choose a reason for hiding this comment

rushatgabhane Sep 20, 2023

Choose a reason for hiding this comment

s77rt Sep 20, 2023

Choose a reason for hiding this comment

s77rt Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

rushatgabhane Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

s77rt Sep 20, 2023

Choose a reason for hiding this comment

rushatgabhane Sep 21, 2023

Choose a reason for hiding this comment

s77rt commented Sep 20, 2023 • edited Loading

rushatgabhane commented Sep 21, 2023

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Sep 21, 2023

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

rushatgabhane commented Sep 20, 2023 •

edited

Loading

Verify that removing/adding hubs throws an error on running `createDocsRoutes`

s77rt Sep 20, 2023 •

edited

Loading

rushatgabhane Sep 20, 2023 •

edited

Loading

s77rt commented Sep 20, 2023 •

edited

Loading