Skip to content

build: switch to docs-content from examples package #14612

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

Conversation

devversion
Copy link
Member

With angular/material.angular.io#565 the docs-content will be pulled from the @angular/material-examples package. Changes needed on this repository:

  • Since we update some styles and logic in favor of simplicity, we need to update the Dgeni templates to conform with these changes.
  • Remove the unnecessary examplesPath property member because we now compute the docs-content/ asset paths in a consistent way and don't want to mix up the source locations.

With angular/material.angular.io#565 the docs-content will be pulled from the `@angular/material-examples` package. Changes needed on this repository:

* Since we update some styles and logic in favor of simplicity, we need to update the Dgeni templates to conform with these changes.
* Remove the unnecessary `examplesPath` property member because we now compute the `docs-content/` asset paths in a consistent way and don't want to mix up the source locations.
@devversion devversion added in progress This issue is currently in progress pr: merge safe labels Dec 22, 2018
@devversion devversion self-assigned this Dec 22, 2018
@devversion devversion requested a review from jelbourn as a code owner December 22, 2018 22:47
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 22, 2018
@devversion devversion added target: patch This PR is targeted for the next patch release and removed in progress This issue is currently in progress labels Dec 23, 2018
<pre class="docs-markdown-pre">
<code class="docs-markdown-code">
{%- highlight "typescript" -%}
const {$ constant.name | safe $}: {$ constant.type | safe $};
{%- end_highlight -%}
</code>
</pre>
</div>
Copy link
Member

Choose a reason for hiding this comment

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

The indentation seems amiss here (and below)

Copy link
Member Author

Choose a reason for hiding this comment

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

That's actually by intention because if we indent the <div> here, the pre and code element would have some additional whitespace and throw off the docs.

I tried using a HTML minifier for Bazel and tested it, but the whitespaces were preserved. That's why the pre and code already were indented in that way (we use a minifier at the moment;)

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Jan 9, 2019
@andrewseguin andrewseguin merged commit 4701c7b into angular:master Jan 11, 2019
andrewseguin pushed a commit that referenced this pull request Jan 11, 2019
With angular/material.angular.io#565 the docs-content will be pulled from the `@angular/material-examples` package. Changes needed on this repository:

* Since we update some styles and logic in favor of simplicity, we need to update the Dgeni templates to conform with these changes.
* Remove the unnecessary `examplesPath` property member because we now compute the `docs-content/` asset paths in a consistent way and don't want to mix up the source locations.
josephperrott pushed a commit to josephperrott/components that referenced this pull request Jan 14, 2019
With angular/material.angular.io#565 the docs-content will be pulled from the `@angular/material-examples` package. Changes needed on this repository:

* Since we update some styles and logic in favor of simplicity, we need to update the Dgeni templates to conform with these changes.
* Remove the unnecessary `examplesPath` property member because we now compute the `docs-content/` asset paths in a consistent way and don't want to mix up the source locations.
@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 Sep 10, 2019
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 target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants