Skip to content

build: fix chips drag-drop example not working and improve example-module generation #20003

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

Merged
merged 2 commits into from
Jul 17, 2020

Conversation

devversion
Copy link
Member

Loading the chips-drag-drop example in the docs site is currently not
possible, as the example files fail to load. This is because the example
id does not match up with the directory that the example is stored within.

This highlights an issue as the docs site assumes a certain folder
structure. This is not ideal and an implementation detail specific to
the Angular Components repository. The docs site should not need to
make any assumptions about where code lives, but instead should just
retrieve this information through the example information. That way we
are free to change layout/file conventions in the components repository
without having to worry about it breaking the docs site.

This is implemented as part of this commit. Also a few sanity checks
that enforce consistency (for improved code health) have been added. The
new concept for examples also allows us to remove empty CSS files for
examples without CSS.

@devversion devversion added P2 The issue is important to a large percentage of users, with a workaround merge safe target: patch This PR is targeted for the next patch release labels Jul 16, 2020
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jul 16, 2020
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

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

LGTM

@crisbeto crisbeto added the lgtm label Jul 16, 2020
@devversion devversion force-pushed the build/fix-examples-chips branch 2 times, most recently from dcfd965 to cd05f95 Compare July 16, 2020 12:28
…dule generation

Loading the chips-drag-drop example in the docs site is currently not
possible, as the example files fail to load. This is because the example
id does not match up with the directory that the example is stored within.

This highlights an issue as the docs site assumes a certain folder
structure. This is not ideal and an implementation detail specific to
the Angular Components repository. The docs site should not need to
make any assumptions about where code lives, but instead should just
retrieve this information through the example information. That way we
are free to change layout/file conventions in the components repository
without having to worry about it breaking the docs site.

This is implemented as part of this commit. Also a few sanity checks
that enforce consistency (for improved code health) have been added. The
new concept for examples also allows us to remove empty CSS files for
examples without CSS.
We now can have examples without CSS files. This was previously not
possible and the docs site just failed loading as it assumed a CSS file
per example. We remove those empty stylesheets as they are superflous to
examples and rather can confuse/distract the examples in the docs.
@devversion devversion force-pushed the build/fix-examples-chips branch from cd05f95 to e506b1b Compare July 16, 2020 12:34
@devversion devversion marked this pull request as ready for review July 16, 2020 13:12
@devversion devversion requested review from andrewseguin, mmalerba and a team as code owners July 16, 2020 13:12
@devversion devversion added the action: merge The PR is ready for merge by the caretaker label Jul 16, 2020
@andrewseguin andrewseguin added target: minor This PR is targeted for the next minor release target: patch This PR is targeted for the next patch release and removed target: patch This PR is targeted for the next patch release labels Jul 17, 2020
@andrewseguin andrewseguin merged commit d00cb12 into angular:master Jul 17, 2020
ngwattcos pushed a commit to ngwattcos/components that referenced this pull request Jul 20, 2020
…dule generation (angular#20003)

* build: fix chips drag-drop example not working and improve example-module generation

Loading the chips-drag-drop example in the docs site is currently not
possible, as the example files fail to load. This is because the example
id does not match up with the directory that the example is stored within.

This highlights an issue as the docs site assumes a certain folder
structure. This is not ideal and an implementation detail specific to
the Angular Components repository. The docs site should not need to
make any assumptions about where code lives, but instead should just
retrieve this information through the example information. That way we
are free to change layout/file conventions in the components repository
without having to worry about it breaking the docs site.

This is implemented as part of this commit. Also a few sanity checks
that enforce consistency (for improved code health) have been added. The
new concept for examples also allows us to remove empty CSS files for
examples without CSS.

* chore: remove empty CSS files from examples

We now can have examples without CSS files. This was previously not
possible and the docs site just failed loading as it assumed a CSS file
per example. We remove those empty stylesheets as they are superflous to
examples and rather can confuse/distract the examples in the docs.
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Aug 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement P2 The issue is important to a large percentage of users, with a workaround target: minor This PR is targeted for the next minor release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants