[HelpDot] Add styling for home page and hub page #27988

rushatgabhane · 2023-09-22T06:40:02Z

cc: @roryabraham @dangrous @arosiclair

Details

⚠️ Merging this PR will deploy ExpensifyHelp to production

Add styling for platform and hubs page, and fixed a typo in "Coming soon" for all articles.
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 styling for home page "Expensify Classic" and "New Expensify" (figma)

Hubs page

Click Expensify Classic / New Expensify
Verify that styling matches - figma

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to help.expensify.com
Verify that you see "Expensify Classic" and "New Expensify"
Click "New Expensify"
Verify that you see 12 hubs in a 4x3 grid
Click "Getting Started"
Click "Expensify Playbook For Small To Medium Sized Businesses"
Verify that you see an article
Click Back <
Verify that it takes you to "Getting Started"

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:
- 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
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Home page

Hubs page

Mobile Web

Home page

Hubs page

… help-dot-styling

melvin-bot · 2023-09-22T17:56:19Z

@0xmiroslav 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]

0xmiros · 2023-09-22T18:04:15Z

Is this final PR for HelpDot project?

rushatgabhane · 2023-09-22T18:17:34Z

@0xmiroslav you could say that.
Future PRs will only have minor enhancements

roryabraham · 2023-09-24T03:00:00Z

@rushatgabhane lint is failing

docs/_data/_routes.yml

docs/_sass/_main.scss

dangrous

One suggestion, this is looking good!

dangrous · 2023-09-25T05:08:42Z

docs/_sass/_main.scss

    @include breakpoint($breakpoint-desktop) {
        grid-template-columns: 50% 50%;
    }
 }

+.platform-cards-group {


Would it be worth extending .cards-group with this one, and just override the breakpoint?

it's just a code style preference, so let's do nothing?
let me know if there is an unwritten rule to prefer extend and override

i think we shouldn't override styles because then the order of styles will change the behavior

I kind of agree that what @dangrous suggests could be a bit cleaner, but I don't think we should treat it as a blocker because it's not a big material difference.

@dangrous if you feel strongly, I'm sure @rushatgabhane would be happy to open a follow-up PR. 🙂

I'm going to resolve this for now to make sure that our team can start writing all the support articles and iterating on the helpsite in production 🚀

thank you @dangrous @roryabraham 😊

on second look, i agree.
will fix it after this PR

yep this is fine to wait!

0xmiros · 2023-09-25T05:10:28Z

Please pull main. Lint error is now gone on main

rushatgabhane · 2023-09-25T05:56:41Z

@roryabraham @dangrous merged main to fix lint, ready for a re-review!

0xmiros · 2023-09-25T05:59:50Z

Just to confirm if this requires C+ review and checklist?

rushatgabhane · 2023-09-25T12:22:34Z

hi @0xmiroslav, if you're able to complete the checklist today please go for it!

0xmiros · 2023-09-25T14:23:15Z

hi @0xmiroslav, if you're able to complete the checklist today please go for it!

on it now

roryabraham · 2023-09-25T14:29:47Z

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

roryabraham · 2023-09-25T14:30:29Z

@0xmiroslav I don't think we need C+ review here. I'll handle the checklist

roryabraham

Looks pretty good. Thanks for cleaning up the styles. Would love to animate the hamburger menu on mobile. It's kind of abrupt

rushatgabhane · 2023-09-25T14:36:51Z

Would love to animate the hamburger menu on mobile. It's kind of abrupt

i like. coming up in future PRs!

Like we said above, I think this is a pretty good suggestion but should be NAB since it's a minor code style preference. I'm sure Rushat will be happy to address this in a follow-up if you feel strongly :)

roryabraham · 2023-09-25T14:42:19Z

deployExpensifyHelp workflow was triggered successfully: https://github.com/Expensify/App/actions/runs/6300964523

roryabraham · 2023-09-25T14:44:50Z

HelpDot deployed successfully:

OSBotify · 2023-09-25T14:48:29Z

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

dangrous

Works for me! Fine to have those follow ups as, er, follow ups

OSBotify · 2023-09-28T19:20:51Z

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

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

OSBotify · 2023-10-02T17:24:47Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.75-12 🚀

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

OSBotify · 2023-10-02T17:53:28Z

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

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

OSBotify · 2023-10-03T15:54:25Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

rushatgabhane added 17 commits September 21, 2023 17:06

use provided description for hubs

0b1c63e

use provided description for hubs

abf3a3d

Merge branch 'Expensify:main' into help-dot-styling

8454059

add platform images

04cb8aa

use kansas font for title other than article

50caf0a

Merge branch 'help-dot-styling' of github.com:rushatgabhane/exfy into…

b0b1838

… help-dot-styling

add hub card styling

ecf6933

add hub card styling

4ab9834

fix typo in resource coming soon

02be804

use correct images

2c27eee

use correct images

f7f2dc9

style platform blub

e33eb7b

use platform style

661d633

add select button to platform card

c6283ec

add select button to platform card

6e296be

enable push to production

a69315c

change hub font weight

1683290

rushatgabhane marked this pull request as ready for review September 22, 2023 17:56

rushatgabhane requested a review from a team as a code owner September 22, 2023 17:56

melvin-bot bot requested review from 0xmiros and removed request for a team September 22, 2023 17:56

rushatgabhane changed the title ~~Help dot styling~~ [HelpDot] Add styling for home page and hub page Sep 22, 2023

rushatgabhane added 3 commits September 23, 2023 01:19

rm whitespace

1e3e752

fix typo

72cd4f7

show getting started at top

d4dbcfa

roryabraham requested changes Sep 24, 2023

View reviewed changes

docs/_data/_routes.yml Outdated Show resolved Hide resolved

docs/_sass/_main.scss Show resolved Hide resolved

rushatgabhane added 2 commits September 24, 2023 14:34

cleanup

c7b0fe8

Update description for platforms

0263c98

dangrous previously requested changes Sep 25, 2023

View reviewed changes

0xmiros mentioned this pull request Sep 25, 2023

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

Closed

96 tasks

Merge branch 'Expensify:main' into help-dot-styling

2754eba

rushatgabhane requested a review from dangrous September 25, 2023 05:56

roryabraham removed the request for review from 0xmiros September 25, 2023 14:30

roryabraham approved these changes Sep 25, 2023

View reviewed changes

roryabraham merged commit 81ed765 into Expensify:main Sep 25, 2023
16 of 19 checks passed

dangrous reviewed Sep 26, 2023

View reviewed changes

OSBotify mentioned this pull request Sep 28, 2023

Deploy Checklist: New Expensify 2023-09-28 #28412

Closed

melvin-bot bot mentioned this pull request Oct 2, 2023

Community Migration to HelpDot - C+ Assistance #27150

Closed

9 tasks

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HelpDot] Add styling for home page and hub page #27988

[HelpDot] Add styling for home page and hub page #27988

rushatgabhane commented Sep 22, 2023 •

edited

Loading

melvin-bot bot commented Sep 22, 2023

0xmiros commented Sep 22, 2023

rushatgabhane commented Sep 22, 2023 •

edited

Loading

roryabraham commented Sep 24, 2023

dangrous left a comment

dangrous Sep 25, 2023

rushatgabhane Sep 25, 2023 •

edited

Loading

rushatgabhane Sep 25, 2023 •

edited

Loading

roryabraham Sep 25, 2023

rushatgabhane Sep 25, 2023

dangrous Sep 26, 2023

0xmiros commented Sep 25, 2023 •

edited

Loading

rushatgabhane commented Sep 25, 2023 •

edited

Loading

0xmiros commented Sep 25, 2023

rushatgabhane commented Sep 25, 2023

0xmiros commented Sep 25, 2023

roryabraham commented Sep 25, 2023 •

edited

Loading

roryabraham commented Sep 25, 2023

roryabraham left a comment

rushatgabhane commented Sep 25, 2023 •

edited

Loading

roryabraham commented Sep 25, 2023 •

edited

Loading

roryabraham commented Sep 25, 2023

OSBotify commented Sep 25, 2023

dangrous left a comment

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

[HelpDot] Add styling for home page and hub page #27988

[HelpDot] Add styling for home page and hub page #27988

Conversation

rushatgabhane commented Sep 22, 2023 • edited Loading

Details

Fixed Issues

Tests

Home page

Hubs page

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Home page

Hubs page

Home page

Hubs page

melvin-bot bot commented Sep 22, 2023

0xmiros commented Sep 22, 2023

rushatgabhane commented Sep 22, 2023 • edited Loading

roryabraham commented Sep 24, 2023

dangrous left a comment

Choose a reason for hiding this comment

dangrous Sep 25, 2023

Choose a reason for hiding this comment

rushatgabhane Sep 25, 2023 • edited Loading

Choose a reason for hiding this comment

rushatgabhane Sep 25, 2023 • edited Loading

Choose a reason for hiding this comment

roryabraham Sep 25, 2023

Choose a reason for hiding this comment

rushatgabhane Sep 25, 2023

Choose a reason for hiding this comment

dangrous Sep 26, 2023

Choose a reason for hiding this comment

0xmiros commented Sep 25, 2023 • edited Loading

rushatgabhane commented Sep 25, 2023 • edited Loading

0xmiros commented Sep 25, 2023

rushatgabhane commented Sep 25, 2023

0xmiros commented Sep 25, 2023

roryabraham commented Sep 25, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

roryabraham commented Sep 25, 2023

roryabraham left a comment

Choose a reason for hiding this comment

rushatgabhane commented Sep 25, 2023 • edited Loading

roryabraham commented Sep 25, 2023 • edited Loading

roryabraham commented Sep 25, 2023

OSBotify commented Sep 25, 2023

dangrous left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 3, 2023

rushatgabhane commented Sep 22, 2023 •

edited

Loading

rushatgabhane commented Sep 22, 2023 •

edited

Loading

rushatgabhane Sep 25, 2023 •

edited

Loading

rushatgabhane Sep 25, 2023 •

edited

Loading

0xmiros commented Sep 25, 2023 •

edited

Loading

rushatgabhane commented Sep 25, 2023 •

edited

Loading

roryabraham commented Sep 25, 2023 •

edited

Loading

rushatgabhane commented Sep 25, 2023 •

edited

Loading

roryabraham commented Sep 25, 2023 •

edited

Loading