-
Notifications
You must be signed in to change notification settings - Fork 6.8k
build: avoid file collisions in docs-content #18691
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
build: avoid file collisions in docs-content #18691
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Looks like a formatting lint warning |
Currently we always move guides, overviews, example files into the `docs-content` by their basename. This means that no guides, overviews, example files with the same name can exist. The last one being processed by Bazel overwrites the previous ones. This can be currently observed in the docs where the custom form-field control example incorrectly displays the MDC-based form-field custom control example. Ultimately breaking StackBlitz. For example: https://material.angular.io/guide/creating-a-custom-form-field-control. Click on the first example, and open it on StackBlitz. We can fix this by preserving the directories where the guides, overviews and example files have been copied from. This also allows us to have multiple overviews in a package without the risk of collisions. Note: Needs an corresponding change in the material.angular.io repo.
b5a72a1
to
8dffd61
Compare
@jelbourn Fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Currently we always move guides, overviews, example files into the `docs-content` by their basename. This means that no guides, overviews, example files with the same name can exist. The last one being processed by Bazel overwrites the previous ones. This can be currently observed in the docs where the custom form-field control example incorrectly displays the MDC-based form-field custom control example. Ultimately breaking StackBlitz. For example: https://material.angular.io/guide/creating-a-custom-form-field-control. Click on the first example, and open it on StackBlitz. We can fix this by preserving the directories where the guides, overviews and example files have been copied from. This also allows us to have multiple overviews in a package without the risk of collisions. Note: Needs an corresponding change in the material.angular.io repo.
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Currently we always move guides, overviews, example files into
the
docs-content
by their basename. This means that no guides,overviews, example files with the same name can exist. The last
one being processed by Bazel overwrites the previous ones.
This can be currently observed in the docs where the custom
form-field control example incorrectly displays the MDC-based
form-field custom control example. Ultimately breaking the StackBlitz.
For example: https://material.angular.io/guide/creating-a-custom-form-field-control.
Click on the first example, and open it on StackBlitz.
We can fix this by preserving the directories where the guides,
overviews and example files have been copied from. This also allows
us to have multiple overviews in a package without the risk of collisions.
Note: Needs an corresponding change in the material.angular.io repo.