Skip to content

Csf-plugin: Move source to docs.source.originalSource#20665

Merged
tmeasday merged 2 commits into
tom/sb-1147-update-api-of-source-blockfrom
shilman/update-csf-plugin-source
Jan 19, 2023
Merged

Csf-plugin: Move source to docs.source.originalSource#20665
tmeasday merged 2 commits into
tom/sb-1147-update-api-of-source-blockfrom
shilman/update-csf-plugin-source

Conversation

@shilman

@shilman shilman commented Jan 18, 2023

Copy link
Copy Markdown
Member

Issue: N/A
Telescopes on #20603

What I did

CSF-plugin extracts the original story source from the CSF file and writes it into the parameters for the story for use in the source block.

Originally, it wrote to the storySource.source parameter for historical reasons. This used to be provided by source-loader, which was shared between addon-docs and addon-storysource.

Now, csf-plugin makes addon-docs completely independent from addon-storysource, so we can refactor the Source block in #20603 to use a different parameter.

This PR writes to docs.source.originalSource. #20603 will also need to be updated accordingly.

How to test

  • See attached unit tests

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@shilman shilman added maintenance User-facing maintenance tasks addon: docs labels Jan 18, 2023

@tmeasday tmeasday left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Lgtm

@tmeasday tmeasday marked this pull request as ready for review January 19, 2023 02:05
@tmeasday tmeasday merged commit 6b80f83 into tom/sb-1147-update-api-of-source-block Jan 19, 2023
@tmeasday tmeasday deleted the shilman/update-csf-plugin-source branch January 19, 2023 02:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addon: docs maintenance User-facing maintenance tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants