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

Docs: Update badly-migrated snippet #28820

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Docs: Update badly-migrated snippet #28820

merged 1 commit into from
Aug 6, 2024

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Aug 6, 2024

What I did

Migration script did not correctly handle snippets with paths that had different filenames. So this fixes one known instance by splitting into two snippets.

Checklist for Contributors

Testing

Manual testing

Preview this branch in locally-run docs

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

Greptile Summary

The pull request addresses a migration issue in the documentation by splitting a snippet into two distinct parts for better clarity.

  • docs/_snippets/angular-builder-production.md: Added two separate snippets for building Storybook with Angular's custom builder.
  • docs/_snippets/custom-build-script-production.md: Deleted redundant file to maintain documentation accuracy.
  • docs/sharing/publish-storybook.mdx: Modified to separate Angular build instructions into a distinct section, improving clarity and accuracy for users of different frameworks.

- Migration script did not correctly handle snippets with paths that had different filenames
@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Aug 6, 2024
@kylegach kylegach self-assigned this Aug 6, 2024
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

3 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@kylegach kylegach merged commit f77eff2 into next Aug 6, 2024
8 of 10 checks passed
@kylegach kylegach deleted the fix-publish-snippet branch August 6, 2024 20:51
Copy link

nx-cloud bot commented Aug 6, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8dfc5cc. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants