NFR: make Sidekick Library available to market websites

cogniSyb commented 7 months ago

Context/Description

When clicking the Library button in the Sidekick extension, you’ll navigate to /tools/sidekick/library.html. This URL is available on all market websites, but no documentation files are present on market websites.

On market websites, we might want to add market-specific documentation.

See for example https://main--vg-macktrucks-com-au--hlxsites.hlx.page/tools/sidekick/library.html, compared to https://main--vg-macktrucks-com--hlxsites.hlx.page/tools/sidekick/library.html

Acceptance Criteria

Editor AC:

From every market website I can click the Library button from the in the Sidekick extension
Clicking the Library button brings me to up-to-date documentation

Non-functional AC:

The Access-Control-Allow-Origin headers will need to be set on the library.json and blocks of the extended library in order for them to load in the sidekick library.
Market-specific block documentation can be added
There should be a check on whether to load the Block Library contents from the main Library
- don’t include when on localhost
- don’t include when on https://main--vg-macktrucks-com--hlxsites.hlx.page/, https://main--vg-macktrucks-com--hlxsites.aem.page/ and other branch names next to main
- don’t include when on https://main--vg-macktrucks-com--hlxsites.hlx.live/, https://main--vg-macktrucks-com--hlxsites.aem.live/ and other branch names next to main

Out of scope

No response

Note

No response

Technical details

By using the extends parameter, we can refer to the original https://github.com/adobe/franklin-sidekick-library?tab=readme-ov-file#extended-libraries

Attachment / link to Figma

No response

BeckyMedlin commented 6 months ago

Needs to be rolled out to the market websites. MT, RC, and VT all prioritized this work as a 2.

mollyaljenkins commented 2 months ago

Suggested approach: Copy blocks from the US site to be accessible on all markets. Upgrade Required.

mollyaljenkins commented 1 week ago

The decision is to use the US sidekick library on all markets with the mono repos. Can this ticket be closed

BeckyMedlin commented 1 week ago

@santi-homps Is this a duplicate ticket of #22 ?

santi-homps commented 1 week ago

@santi-homps Is this a duplicate ticket of #22 ?

Not entirely but 22 solves some of the issues here. Others should be revised to check if still apply

aemsites / vg-macktrucks-com