Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(support-pages): Add a new import script #275

Closed
wants to merge 27 commits into from

Conversation

amol-anand
Copy link
Collaborator

@amol-anand amol-anand commented Jul 12, 2023

Issue

Fixes #256
Fixes #280
Fixes #281

Description

Added a new import script to import Support pages to Franklin

New

  • new import script specifically modified for Support pages
  • added breadcrumb block to support adding fragments to support pages
  • added new search block to filter and search across any pages (based on a path filter)
  • Sidebar functionality

Changed

  • Moved existing import.js script to import-docs.js as that was used to import PDF doc pages

Testing Instruction

Before: https://main--merative2--hlxsites.hlx.page/support/micromedex-product-support-details
After: https://support-pages-import--merative2--hlxsites.hlx.page/support/micromedex-product-support-details
After: https://support-pages-import--merative2--hlxsites.hlx.page/support/spm/flashes/configure-target-issue-jdbc-connection
After: https://support-pages-import--merative2--hlxsites.hlx.page/support/spm/support-articles

In Progress

  • Need to update the import script to identify and replace the breadcrumb with the fragment already built out
  • Need to manually update certain pages to look correct that would not be handled via the import script
  • Table block might be needed for some pages

@aem-code-sync
Copy link

aem-code-sync bot commented Jul 12, 2023

Hello, I'm Franklin Bot and I will run some test suites that validate the page speed.
In case there are problems, just click the checkbox below to rerun the respective action.

  • Re-run PSI Checks

@aem-code-sync
Copy link

aem-code-sync bot commented Jul 12, 2023

Page Scores Audits Google
/support/micromedex-product-support-details PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

@proeung proeung changed the title Support pages import feat(support-pages): Add a new import script Jul 13, 2023
Copy link

@proeung proeung left a comment

Choose a reason for hiding this comment

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

@amol-anand Thanks for adding this import-support.js to the repo for future reference!

A couple of notes/questions

  • I can see in the Sharepoint directory that you've copied the imported docs to the /support. Is there a way to bulk publish these pages once we're ready to switch the routing from AEM to Franklin? @keith-kaplan Do we have a plan to reach out to certain stakeholders regarding this migration? Just wanted to ensure folks are aware that they will need to switch their content entry process from AEM to Franklin.
  • Some support pages include a breadcrumb, sidebar, styling for the tables, etc. For these pages, we might need to adjust the import script to look for these elements and convert them into blocks (eg. Breadcrumb as a fragment). Let me know how you'd like to tackle this portion of the support page migration effort. I can create a separate issue to handle the creation and styling of some of these blocks/components.

Screen Shot 2023-07-13 at 9 59 15 AM

AEM version: https://www.merative.com/support/spm/flashes/configure-target-issue-jdbc-connection
Franklin version: https://main--merative2--hlxsites.hlx.page/support/spm/flashes/configure-target-issue-jdbc-connection

@keith-kaplan
Copy link
Collaborator

I haven't had that conversation yet. I'd like to this to be in a bit better shape to show them. I know som of the sidebar features are controlled by shortcodes/fragments in AEM. We'll need to look into having that implemented.

@proeung
Copy link

proeung commented Jul 13, 2023

@keith-kaplan Yeah, that makes sense. Looks like the breadcrumbs and sidebar (document info) will need to be treated as block fragments so that they're re-usable on other pages.

@amol-anand
Copy link
Collaborator Author

amol-anand commented Jul 13, 2023

Is there a way to bulk publish these pages once we're ready to switch the routing from AEM to Franklin

Yes. Using the sidekick from sharepoint folder level we can select multiple files and then preview and publish.

Looks like the breadcrumbs and sidebar (document info) will need to be treated as block fragments so that they're re-usable on other pages.

Agreed. Let's create two separate issues for the sidebar and breadcrumb. Once those are built, then we can modify this script to include them if they exist on the page. I would keep this PR open until that is completed.

@proeung proeung added the On-Hold Work is on-hold until proper sign off label Jul 14, 2023
@proeung
Copy link

proeung commented Jul 14, 2023

@amol-anand Here are the two issues related to the support migration work. Also, @keith-kaplan feel free to adjust the description if there are some details that are missing.

@aem-code-sync
Copy link

aem-code-sync bot commented Jul 14, 2023

Page Scores Audits Google
/support/micromedex-product-support-details PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

@aem-code-sync
Copy link

aem-code-sync bot commented Jul 21, 2023

Page Scores Audits Google
/support/micromedex-product-support-details PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

@aem-code-sync
Copy link

aem-code-sync bot commented Jul 31, 2023

Page Scores Audits Google
/support/micromedex-product-support-details PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

@proeung
Copy link

proeung commented Jul 31, 2023

@amol-anand Any update on the remaining work for the Support pages migration? Also, are you planning on opening a new PR or working within this one?

@aem-code-sync
Copy link

aem-code-sync bot commented Aug 1, 2023

Page Scores Audits Google
/support/micromedex-product-support-details PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

@amol-anand
Copy link
Collaborator Author

@amol-anand Any update on the remaining work for the Support pages migration? Also, are you planning on opening a new PR or working within this one?

I'm going to work in this same PR to resolve the two outstanding issues. Something I am looking to work on this week.

@aem-code-sync
Copy link

aem-code-sync bot commented Aug 1, 2023

Page Scores Audits Google
/support/micromedex-product-support-details PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

@aem-code-sync
Copy link

aem-code-sync bot commented Aug 1, 2023

@aem-code-sync
Copy link

aem-code-sync bot commented Aug 1, 2023

Copy link

@proeung proeung left a comment

Choose a reason for hiding this comment

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

Looks good overall! @keith-kaplan and I just have some follow up changes that we think would be good to implement in this migration effort.

Let me know if you have availability to address these feedback.

.section.breadcrumb-container > div.breadcrumb-wrapper {
padding: unset;
width: 100%;
background-color: #F3F1ED;
Copy link

Choose a reason for hiding this comment

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

Suggested change
background-color: #F3F1ED;
background-color: var(--neutral-40);

Let's add this neutral 40% hex color variable to our style.css - --neutral-40: F3F1ED;

Comment on lines +1 to +26
/* Right Nav CSS */

@media only screen and (min-width: 1200px) {
main .section.right-nav-container > div {
width: unset;
}

.section.right-nav-container {
position: relative;
display: grid;
grid-template-columns: 3fr 1fr;
width: var(--section-width-desktop);
margin: 0 auto;
}

.section.right-nav-container > *:not(.right-nav-wrapper) {
grid-column-start: 1;
}

.section.right-nav-container > .right-nav-wrapper {
grid-column-start: 2;
grid-row-start: 1;
padding-top: var(--spacer-layout-07);
margin-left: 8%;
}
}
Copy link

Choose a reason for hiding this comment

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

Nitpicking: I think we should rename this block right-nav to sidebar. "Right Nav" implies that it's navigational content, however, this is more supplemental info.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

feel free to change the name. whatever makes more sense for you

@@ -0,0 +1,76 @@
/* Search Block CSS */
Copy link

Choose a reason for hiding this comment

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

Note: We'll clean up some of the stylings to ensure that we're using the spacings and etc from the design specs.

scripts/scripts.js Show resolved Hide resolved
docInfo.remove();
}
}

Copy link

Choose a reason for hiding this comment

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

Can we add a check to the import script to map additional fields like the Category, Parent, and Product Family to the metadata section, especially for Curam/SPM support pages?

For instance, if the page is /support/spm/* or /support/curam/*, map the following metadata field to the sharepoint doc structure.

Category - Health and human services
Parent - Social Program Management
Product Family - Social Program Management Top

@keith-kaplan Let me know if there are other metadata fields that you'd like to add as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes we can do this in the import code - BUT we can also do this via bulk metadata especially since it is limited by path.
Putting it in the individual page metadata would imply that authors should be changing this (which I don't think is the use-case here since this is all analytics related IIRC)?

@proeung proeung added Needs Stakeholders sign off Merative team sign off and removed On-Hold Work is on-hold until proper sign off labels Aug 8, 2023
@keith-kaplan
Copy link
Collaborator

@proeung added a few more details for the metadata rows that need to be added.

For all of the SPM Pages

  • Category - Health and human services
  • orgFunction – Support
  • Page Type - Support
  • Parent – Social Program Management
  • Product Family – Cúram Top

For all of the Integrated Care Pages

  • Category - Health and human services
  • orgFunction – Support
  • Page Type - Support
  • Parent – Social Program Management
  • Product Family – Cúram Integrated Care

@proeung proeung self-assigned this Aug 22, 2023
@proeung proeung added On-Hold Work is on-hold until proper sign off and removed Needs Stakeholders sign off Merative team sign off labels Sep 1, 2023
@proeung proeung added 🛠️ fix needed and removed On-Hold Work is on-hold until proper sign off labels Sep 12, 2023
@proeung
Copy link

proeung commented Oct 2, 2023

Closing this PR in favor of this new one (#346) that resolves all merge conflicts and include missing styles and code clean up.

@proeung proeung closed this Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants