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.

Sign up for GitHub

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

Jump to bottom

build(docs-infra): package entry points API templates #25453

Closed
wants to merge 5 commits into from
Closed

build(docs-infra): package entry points API templates #25453

wants to merge 5 commits into from

Conversation

petebacondarwin
Copy link
Member

No description provided.

@petebacondarwin petebacondarwin added action: review The PR is still awaiting reviews from at least one requested reviewer comp: docs-infra target: patch This PR is targeted for the next patch release labels Aug 13, 2018
@petebacondarwin petebacondarwin added this to the Backlog milestone Aug 13, 2018
@ngbot ngbot bot modified the milestones: Backlog, needsTriage Aug 13, 2018
@mary-poppins
Copy link

You can preview 16e2f1a at https://pr25453-16e2f1a.ngbuilds.io/.

@petebacondarwin
Copy link
Member Author

You can see a class inside a secondary entry point, which is inside a package here: https://pr25453-16e2f1a.ngbuilds.io/api/animations/browser/AnimationDriver

@petebacondarwin
Copy link
Member Author

petebacondarwin commented Aug 13, 2018 •
edited

Here are some screenshots:

screen shot 2018-08-13 at 12 32 22

screen shot 2018-08-13 at 12 32 00

screen shot 2018-08-13 at 12 31 47

@jbogarthyde
Copy link
Contributor

LGTM

IgorMinar
IgorMinar suggested changes Aug 13, 2018
View reviewed changes
aio/tools/transforms/templates/api/package.template.html Outdated
@@ -24,12 +24,12 @@ <h3>{$ title $}</h3>

{% include "includes/see-also.html" %}

<h2>Entry points</h2>
{$ listItems([doc.packageInfo.primary], 'Primary') $}
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we keep the primary entry point listed on the package page along with the description of the entry point as we had it? Otherwise the "Primary entry point exports" heading seems a bit out of place.

So the package template would contain:

## Entry Points
### Primary
| @angular/animations | once sentence description |

### Secondary
| @angular/animations/foo | once sentence description |
| @angular/animations/bar | once sentence description |

## Primary Entry Point Exports
...

Copy link
Contributor

Choose a reason for hiding this comment

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

It would also be awesome if we could make the primary entry point table entry (e.g. @angular/animations) a link to the Primary Entry Point Exports rather than link back to the package, which will confuse people.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll make that happen

packages/animations/PACKAGE.md Outdated
@@ -27,3 +27,4 @@ and reverse an animation sequence.

@see Find out more in the [animations guide](guide/animations).
@see See what polyfills you might need in the [browser support guide](guide/browser-support).
@experimental
Copy link
Contributor

@IgorMinar IgorMinar Aug 13, 2018 •
edited

Choose a reason for hiding this comment

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

Pete, I think you missed the discussion where we agreed that these tags are meaningless because users don't really see them and as of now, all apis regardless of the experimental label are considered stable and can't be broken without a deprecation/update plan.

Can you please remove this tag and also remove the support for displaying these tags in the templates you touched here. Thanks!

Copy link
Member Author

Choose a reason for hiding this comment

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

OK - I did miss that

@petebacondarwin
Copy link
Member Author

@IgorMinar - done PTAL

@mary-poppins
Copy link

You can preview e588bf9 at https://pr25453-e588bf9.ngbuilds.io/.

IgorMinar
IgorMinar approved these changes Aug 14, 2018
View reviewed changes
Copy link
Contributor

@IgorMinar IgorMinar left a comment

Choose a reason for hiding this comment

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

yup. looks good to me now! thanks

@petebacondarwin petebacondarwin added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Aug 14, 2018
benlesh pushed a commit that referenced this pull request Aug 14, 2018
@petebacondarwin @benlesh
build(docs-infra): change breadcrumb delimiter to > (#25453)
1c86e9b 
PR Close #25453
benlesh pushed a commit that referenced this pull request Aug 14, 2018
@petebacondarwin @benlesh
build(docs-infra): include packages in API template breadcrumbs (#25453)
bf441e8 
PR Close #25453
benlesh pushed a commit that referenced this pull request Aug 14, 2018
@petebacondarwin @benlesh
build(docs-infra): clean up API package template (#25453)
2f85b16 
PR Close #25453
benlesh pushed a commit that referenced this pull request Aug 14, 2018
@petebacondarwin @benlesh
build(docs-infra): remove stability labels from API docs (#25453)
cdee9ad 
PR Close #25453
@benlesh benlesh closed this in 78f4776 Aug 14, 2018
benlesh pushed a commit that referenced this pull request Aug 14, 2018
@petebacondarwin @benlesh
build(docs-infra): include packages in API template breadcrumbs (#25453)
4e45f2c 
PR Close #25453
benlesh pushed a commit that referenced this pull request Aug 14, 2018
@petebacondarwin @benlesh
build(docs-infra): clean up API package template (#25453)
6a21301 
PR Close #25453
benlesh pushed a commit that referenced this pull request Aug 14, 2018
@petebacondarwin @benlesh
build(docs-infra): remove stability labels from API docs (#25453)
c13901f 
PR Close #25453
@petebacondarwin petebacondarwin deleted the aio-package-entry-points branch August 15, 2018 19:10
FrederikSchlemmer pushed a commit to FrederikSchlemmer/angular that referenced this pull request Jan 3, 2019
@petebacondarwin @FrederikSchlemmer
build(docs-infra): change breadcrumb delimiter to > (angular#25453)
bb39878 
PR Close angular#25453
FrederikSchlemmer pushed a commit to FrederikSchlemmer/angular that referenced this pull request Jan 3, 2019
@petebacondarwin @FrederikSchlemmer
build(docs-infra): include packages in API template breadcrumbs (angu…
69a3bc2 
…lar#25453)

PR Close angular#25453
FrederikSchlemmer pushed a commit to FrederikSchlemmer/angular that referenced this pull request Jan 3, 2019
@petebacondarwin @FrederikSchlemmer
build(docs-infra): clean up API package template (angular#25453)
c39bba3 
PR Close angular#25453
FrederikSchlemmer pushed a commit to FrederikSchlemmer/angular that referenced this pull request Jan 3, 2019
@petebacondarwin @FrederikSchlemmer
build(docs-infra): remove stability labels from API docs (angular#25453)
e3bcc2d 
PR Close angular#25453
@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 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@IgorMinar IgorMinar IgorMinar approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker cla: yes target: patch This PR is targeted for the next patch release
Projects
None yet
Milestone
needsTriage
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@petebacondarwin @mary-poppins @jbogarthyde @IgorMinar @googlebot