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

[WIP] enable Sentinel tutorials without requiring them #2569

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

zchsh
Copy link
Contributor

@zchsh zchsh commented Sep 11, 2024

🗒️ What

This PR fixes a few small issues discovered when trying to run the Tutorials content workflows locally.

🛠️ How

  • In IconTile, adds support for sentinel and hcp "brand colors"
    • These are styled identically to the "neutral" theme, as we have no specific brand colors in these cases
  • Update PRODUCT_ICON_MAP for card badges to include sentinel as an option
    • We have no logo, so we use the HashiCorp H logo
  • Update fetchAllCollectionsByProduct to split out setting of theme
    • For all products but Sentinel, theme and product.slug can be the same value. For Sentinel, this errors.
    • Splits out theme to a separate argument, and makes it optional, so that Sentinel can render without error.
  • Update collection-view server to render Sentinel collections
    • For all products but Sentinel, we only render collections that have a matching theme and product.slug.
    • For Sentinel, there is no sentinel theme, so this would result in zero collection pages. This PR updates to add a conditional similar to the one used for HCP content to render all Sentinel collections.

🧪 Testing

To fully test these changes, run the full end-to-end content workflows for Tutorials locally. A more detailed guide: 2024-09-11 - tutorials local setup

Copy link

vercel bot commented Sep 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dev-portal ❌ Failed (Inspect) Sep 13, 2024 5:25pm

Copy link

github-actions bot commented Sep 11, 2024

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

This PR introduced no changes to the javascript bundle 🙌

@zchsh zchsh changed the title work on sentinel tutorial setup fix sentinel tutorials consumption issues Sep 11, 2024
@zchsh zchsh marked this pull request as ready for review September 11, 2024 19:10
@zchsh zchsh changed the base branch from create-sentinel-tutorial to main September 13, 2024 15:22
@zchsh zchsh changed the title fix sentinel tutorials consumption issues [WIP] enable Sentinel tutorials without requiring them Sep 13, 2024
im2nguyen and others added 17 commits September 13, 2024 13:13
Rationale for reverting th basePaths change: we only ever use product data basePaths for redirects from the previous dot-io sites. This property should likely be renamed, or perhaps removed entirely, as redirects could probably be written in a more static way now that we've completed our migration to Dev Dot.

Rationale for reverting the rootDocsPath change: up until the point we fully remove intro content, including the page files, we need to maintain this data, otherwise the build will fail. Recommendation is to remove intro content in a separate PR.
Holding until Sentinel tutorials are published
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants