[HelpDot] Show platforms and hubs #27932

rushatgabhane · 2023-09-21T10:33:25Z

Details

In this PR, we're displaying all the platforms, hubs and articles for them.

The hubs are in a 6x2 grid, the platforms don't have the correct image, styling and description. That'll be done in the next PR.

Design doc link

Fixed Issues

$ #27150
PROPOSAL: N.A.

Tests

Run cd docs && npm run createDocsRoutes
Verify that it runs successfully
Run bundle exec jekyll serve --livereload to start HelpDot

Home page

Verify that you see two platforms "Expensify Classic" and "New Expensify"
Verify you see them in LHN with arrow >

oldDot hubs

Click "Expensify Classic"
Verify that you see a 6x2 grid showing the hubs mentioned in design doc.
Verify that the icons match figma

newDot hubs

Click "New Expensify"
Verify that you see a 2x6 grid showing the hubs mentioned in design doc.
Verify that the icons look similar to Expensify Classic hubs.

Hub page showing articles and section - Bank Accounts & Credit Cards

Click "Expensify Classic" in LHN
Click "Bank Accounts & Credit Cards"
Verify that it shows articles and sections inside it.
Verify that the LHN expands and highlights the hub

Article - Getting Started - Playbook

In Expensify Classic, go to "Getting Started" hub
Open any playbook article
Verify that scrolling the article scrolls the LHN and highlights the headings
Click back <
Veirfy that you're brought back to "Getting Started" hub page, and it's selected in LHN.

Deep link test

In a new tab, open http://localhost:4000/articles/expensify-classic/getting-started/playbooks/Expensify-Playbook-For-Small-To-Medium-Sized-Businesses#gsc.tab=0
Click back <
Verify that you're brought back to "Getting Started" hub page, and it's selected in LHN.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that help.expensify.com is working

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Home page

oldDot hubs

newDot hubs

Hub page showing articles and section - Bank Accounts & Credit Cards

Article - Getting Started - Playbook

testing back button

Screen.Recording.2023-09-21.at.16.11.59.mov

Deep link test

Screen.Recording.2023-09-21.at.16.14.14.mov

M-Web

Screen.Recording.2023-09-21.at.16.42.54.mov

melvin-bot · 2023-09-21T11:06:08Z

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

rushatgabhane · 2023-09-21T11:53:20Z

docs/assets/js/main.js

+    // Path name is of the form /articles/[platform]/[hub]/[resource]
+    const path = window.location.pathname.split('/');
+    if (path[2] && path[3]) {
+        window.location.href = `/${path[2]}/hubs/${path[3]}`;


navigates to [platform-name]/hubs/[hub-name]

rushatgabhane · 2023-09-22T02:38:35Z

@roryabraham try deleting _site

and run npm run createDocsRoutes && bundle exec jekyll serve?

rushatgabhane · 2023-09-22T02:43:03Z

@roryabraham what is the output of npm run createDocsRoutes? You have to be in docs directory when you run it.

roryabraham · 2023-09-22T02:52:27Z

Sorry, hadn't run npm run createDocsRoutes. Ignore me... 😅

roryabraham · 2023-09-22T02:53:55Z

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

roryabraham

http://127.0.0.1:4000/new-expensify/hubs/exports is giving me a blank page, let's add a coming soon page for it please

roryabraham · 2023-09-22T03:05:41Z

Also providing faster feedback in https://expensify.slack.com/archives/C02QSAC6BJ8/p1695350666656869

OSBotify · 2023-09-22T03:39:26Z

✋ 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-22T13:59:20Z

🚀 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:11Z

🚀 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:12Z

🚀 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:48:33Z

🚀 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 10 commits September 21, 2023 15:39

show platforms in homepage

0b2c77e

show platforms in homepage

a56668f

add platform cards

08a3bae

show platform sepecific articles

0049227

show platform specific hubs

e157b28

show platform specific articles

47087a7

show platforms in LHN

ab47aca

show hubs and articles in LHN

f3a4367

fix: deeplinking and pressing back

c68317d

add icons for hubs

7980860

rushatgabhane marked this pull request as ready for review September 21, 2023 11:06

rushatgabhane requested a review from a team as a code owner September 21, 2023 11:06

melvin-bot bot requested review from burczu and removed request for a team September 21, 2023 11:06

rushatgabhane commented Sep 21, 2023

View reviewed changes

This comment was marked as resolved.

Sign in to view

roryabraham requested review from roryabraham and removed request for burczu September 22, 2023 02:53

roryabraham requested changes Sep 22, 2023

View reviewed changes

add hub for exports

4cdd4b1

rushatgabhane requested a review from roryabraham September 22, 2023 03:00

rushatgabhane added 2 commits September 22, 2023 08:50

fix title case

869aa1c

remove console log

4f97552

roryabraham approved these changes Sep 22, 2023

View reviewed changes

roryabraham merged commit 131685a into Expensify:main Sep 22, 2023
13 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

rushatgabhane deleted the rush-help-dot branch December 19, 2023 00:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HelpDot] Show platforms and hubs #27932

[HelpDot] Show platforms and hubs #27932

rushatgabhane commented Sep 21, 2023 •

edited

Loading

melvin-bot bot commented Sep 21, 2023

rushatgabhane Sep 21, 2023 •

edited

Loading

This comment was marked as resolved.

This comment was marked as resolved.

rushatgabhane commented Sep 22, 2023 •

edited

Loading

rushatgabhane commented Sep 22, 2023

roryabraham commented Sep 22, 2023

roryabraham commented Sep 22, 2023 •

edited

Loading

roryabraham left a comment

roryabraham commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

[HelpDot] Show platforms and hubs #27932

[HelpDot] Show platforms and hubs #27932

Conversation

rushatgabhane commented Sep 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Home page

oldDot hubs

newDot hubs

Hub page showing articles and section - Bank Accounts & Credit Cards

Article - Getting Started - Playbook

Deep link test

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Home page

oldDot hubs

newDot hubs

Hub page showing articles and section - Bank Accounts & Credit Cards

Article - Getting Started - Playbook

Deep link test

melvin-bot bot commented Sep 21, 2023

rushatgabhane Sep 21, 2023 • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

rushatgabhane commented Sep 22, 2023 • edited Loading

rushatgabhane commented Sep 22, 2023

roryabraham commented Sep 22, 2023

roryabraham commented Sep 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

rushatgabhane commented Sep 21, 2023 •

edited

Loading

rushatgabhane Sep 21, 2023 •

edited

Loading

rushatgabhane commented Sep 22, 2023 •

edited

Loading

roryabraham commented Sep 22, 2023 •

edited

Loading