Fix callouts in OAuth Git quickstarts (GitLab, Azure DevOps, Bitbucket)#3326
Fix callouts in OAuth Git quickstarts (GitLab, Azure DevOps, Bitbucket)#3326sfc-gh-jbilek wants to merge 4 commits into
Conversation
The new snowflake.com developer guides renderer strips <aside class="…"> wrappers and dumps the inner markdown as raw text, so lines like **GitHub** show literal asterisks instead of bold and links never parse. Replace each aside with a single-line `> **Note:** …` blockquote, which the renderer turns into a styled <blockquote> (verified on the existing configure-cicd-integrations-with-snowflake guide). Affects all three guides: GitLab, Azure DevOps, Bitbucket.
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
A reader on the GitLab quickstart wants GitLab steps, not a detour to the GitHub App. The provider choice belongs on the docs page, not at the top of a provider-specific guide.
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
The Bitbucket overview repeated the gotcha that already sits next to the SQL block, and the Azure DevOps overview pre-explained an endpoint detail before any endpoint had been introduced. Both belonged where the corresponding configuration step happens, not at the top.
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
🔗 Staging Preview ReadyQuickstart:
Generated by GitHub Actions |
3 participants
Summary
The new snowflake.com developer guides renderer strips
<aside class="positive">/<aside class="negative">wrappers and dumps the inner markdown as raw text. On the live pages this shows up as literal**bold**syntax and unparsed[link text](url)markdown — see the GitHub callout near the top of each guide today, e.g. https://www.snowflake.com/en/developers/guides/snowflake-git-oauth-gitlab/.This PR replaces every
<aside>block in the three OAuth Git quickstarts (added in #3315) with a single-line> **Note:** …blockquote. The renderer wraps blockquotes in a styled<blockquote>element with proper bold + link rendering — verified on the existing Configure CI/CD Integrations guide which uses the same syntax.Convention used:
<aside class="positive">(helpful tips) →> **Tip:** …<aside class="negative">(gotchas / warnings) →> **Important:** …Affected files
site/sfguides/src/snowflake-git-oauth-gitlab/snowflake-git-oauth-gitlab.md(5 callouts)site/sfguides/src/snowflake-git-oauth-azure-devops/snowflake-git-oauth-azure-devops.md(4 callouts)site/sfguides/src/snowflake-git-oauth-bitbucket/snowflake-git-oauth-bitbucket.md(3 callouts)Net diff: 12 insertions, 36 deletions.
Test plan
**bold**or[text](url)syntax visible).