Skip to content

Commit

Permalink
feat: refactor component to use slots and respect inline .md formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@jeff-matthews
jeff-matthews committed Nov 5, 2024
1 parent dcb57e8 commit 3671bce
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 41 deletions.
16 changes: 9 additions & 7 deletions src/components/Checklist.astro
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
---
export interface Props {
tasks: string[];
tasks?: string[];
}
const { tasks } = Astro.props as Props;
---

<check-list>
<div class="checklist">
{tasks.map((task, index) => (
<label key={index}>
<input type="checkbox" />
<span>{task}</span>
</label>
))}
<slot name="tasks">
{tasks && tasks.map((task, index) => (
<label key={index}>
<input type="checkbox" />
<span>{task}</span>
</label>
))}
</slot>
</div>
</check-list>

Expand Down
146 changes: 112 additions & 34 deletions src/content/docs/launch/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,52 +43,130 @@ Start your checklist with the [Go-Live Checklist](https://www.aem.live/docs/go-l

### Catalog service

<Checklist tasks={[
"Switch to the Catalog Service production endpoint (https://catalog-service.adobe.io/graphql).",
"Ensure a production environment is configured in the Service Connector (will result in a new `environmentId`).",
"Sync the production catalog to the new production environment.",
"Create a new Commerce production API key-pair and use the public key as the `x-api-key` value.",
"Double check category IDs and make sure all category pages have a reference to the correct category.",
"Update `environmentId` and `x-api-key` values in the `.helix/config.xlsx` file.",
"Let the Catalog Service team know about the new production environment and launch date.",
]} />
<Checklist>
<div slot="tasks">
<label>
<input type="checkbox" />
<span>Switch to the Catalog Service production endpoint (https://catalog-service.adobe.io/graphql).</span>
</label>
<label>
<input type="checkbox" />
<span>Ensure a production environment is configured in the Service Connector (will result in a new `environmentId`).</span>
</label>
<label>
<input type="checkbox" />
<span>Sync the production catalog to the new production environment.</span>
</label>
<label>
<input type="checkbox" />
<span>Create a new Commerce production API key-pair and use the public key as the `x-api-key` value.</span>
</label>
<label>
<input type="checkbox" />
<span>Double check category IDs and make sure all category pages have a reference to the correct category.</span>
</label>
<label>
<input type="checkbox" />
<span>Update `environmentId` and `x-api-key` values in the `.helix/config.xlsx` file.</span>
</label>
<label>
<input type="checkbox" />
<span>Let the Catalog Service team know about the new production environment and launch date.</span>
</label>
</div>
</Checklist>

### CDN and caching

<Checklist tasks={[
"Use the production GraphQL endpoint `yourproject.com/graphql` (needs to be changed in the CDN). Make sure to also use this for all the Sidekick extensions and scripts (e.g., sitemap generation, image importer).",
"When using Adobe Commerce Fastly, request a new CDN purge token for Commerce production environment. Update in Sharepoint in the `.helix/config.xlsx` file (`authToken` and `serviceId`).",
"Validate your [CDN configuration](/setup/content-delivery-network/) and ensure that caching and cache invalidation work as expected.",
"For multi store setups, ensure that you add a store specific cache buster (e.g. query parameter or proxy via CDN) to Catalog Service and LiveSearch requests.",
]} />
<Checklist>
<div slot="tasks">
<label>
<input type="checkbox" />
<span>Use the production GraphQL endpoint `yourproject.com/graphql` (needs to be changed in the CDN). Make sure to also use this for all the Sidekick extensions and scripts (e.g., sitemap generation, image importer).</span>
</label>
<label>
<input type="checkbox" />
<span>When using Adobe Commerce Fastly, request a new CDN purge token for Commerce production environment. Update in Sharepoint in the `.helix/config.xlsx` file (`authToken` and `serviceId`).</span>
</label>
<label>
<input type="checkbox" />
<span>Validate your [CDN configuration](/setup/content-delivery-network/) and ensure that caching and cache invalidation work as expected.</span>
</label>
<label>
<input type="checkbox" />
<span>For multi store setups, ensure that you add a store specific cache buster (e.g. query parameter or proxy via CDN) to Catalog Service and LiveSearch requests.</span>
</label>
</div>
</Checklist>

### Security and access

<Checklist tasks={[
"Verify/update password reset links. Match the Edge Delivery Services implementation in the Adobe Commerce Admin.",
"Provide and configure production keys for integrations and payment providers.",
"Verify that the new domains/subdomains are allowlisted and potential backend webhooks are working.",
]} />
<Checklist>
<div slot="tasks">
<label>
<input type="checkbox" />
<span>Verify/update password reset links. Match the Edge Delivery Services implementation in the Adobe Commerce Admin.</span>
</label>
<label>
<input type="checkbox" />
<span>Provide and configure production keys for integrations and payment providers.</span>
</label>
<label>
<input type="checkbox" />
<span>Verify that the new domains/subdomains are allowlisted and potential backend webhooks are working.</span>
</label>
</div>
</Checklist>

### SEO and indexing

<Checklist tasks={[
"Add a `robots.txt` file to your project, which allows your site to be indexed by search engines. Ensure that your sitemaps are referenced and that you add rules to block indexing of any content that you do not want to be indexed (for example, the `/drafts` folder).",
"Add one or multiple [redirect](https://www.aem.live/docs/redirects) files to ensure that URLs that were changed as part of the migration still work (for example, when you remove the `.html` file extension).",
"Generate a sitemap for your site and catalog. To speed up the indexing process, Adobe recommends adding the sitemap to Google Search Console.",
"Ensure that your product detail pages have [metadata and structured data](/seo/metadata/) (for example, LD-JSON data is configured).",
]} />
<Checklist>
<div slot="tasks">
<label>
<input type="checkbox" />
<span>Add a `robots.txt` file to your project, which allows your site to be indexed by search engines. Ensure that your sitemaps are referenced and that you add rules to block indexing of any content that you do not want to be indexed (for example, the `/drafts` folder).</span>
</label>
<label>
<input type="checkbox" />
<span>Add one or multiple [redirect](https://www.aem.live/docs/redirects) files to ensure that URLs that were changed as part of the migration still work (for example, when you remove the `.html` file extension).</span>
</label>
<label>
<input type="checkbox" />
<span>Generate a sitemap for your site and catalog. To speed up the indexing process, Adobe recommends adding the sitemap to Google Search Console.</span>
</label>
<label>
<input type="checkbox" />
<span>Ensure that your product detail pages have [metadata and structured data](/seo/metadata/) (for example, LD-JSON data is configured).</span>
</label>
</div>
</Checklist>

### Performance and monitoring

<Checklist tasks={[
"Validate your [storefront events](https://github.com/adobe/commerce-events/tree/main/examples/events/snowplow-debugger) implementation and ensure that data is displayed in your Live Search and Product Recommendation dashboards in the Adobe Commerce Admin.",
"Ensure that the site's Lighthouse score is green; targeting `100` on every page (taking into account previous considerations mentioned on this document).",
]} />
<Checklist>
<div slot="tasks">
<label>
<input type="checkbox" />
<span>Validate your [storefront events](https://github.com/adobe/commerce-events/tree/main/examples/events/snowplow-debugger) implementation and ensure that data is displayed in your Live Search and Product Recommendation dashboards in the Adobe Commerce Admin.</span>
</label>
<label>
<input type="checkbox" />
<span>Ensure that the site's Lighthouse score is green; targeting `100` on every page (taking into account previous considerations mentioned on this document).</span>
</label>
</div>
</Checklist>

### Project management and updates

<Checklist tasks={[
"Notify Adobe early about your planned launch date to ensure that the Adobe Commerce team is available to support you during the launch.",
"Check for the latest boilerplate changes and update your project accordingly.",
]} />
<Checklist>
<div slot="tasks">
<label>
<input type="checkbox" />
<span>Notify Adobe early about your planned launch date to ensure that the Adobe Commerce team is available to support you during the launch.</span>
</label>
<label>
<input type="checkbox" />
<span>Check for the latest boilerplate changes and update your project accordingly.</span>
</label>
</div>
</Checklist>

0 comments on commit 3671bce

Please sign in to comment.