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

docs(docs-infra): add status filter to api reference overview #57614

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(docs-infra): add status filter to api reference overview #57614

wants to merge 1 commit into from

Conversation

mvdluit
Copy link
Contributor

@mvdluit mvdluit commented Aug 30, 2024 •
edited
Loading

add a status filter on the api reference overview page to filter on status (all|stable|deprecated|developer-preview|experimental)

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.dev application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Currently it's not possible to filter the API references on status, except for showing deprecated items in the list of references.

Issue Number: #57119

What is the new behavior?

Replaced the 'show deprecated' toggle with a button dropdown that allows you to select All | Stable | Deprecated | Developer-preview | Experimental allowing to quickly get an overview of which items are safe to use in production and which are currently in developer preview/experimental

The status is also accessible via a queryParam: https://angular.dev/api?status=developer-preview which can be used to link to from an external source or from within the docs (e.g. https://angular.dev/reference/releases#developer-preview can be updated with a direct link to a list of developer-preview references)

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@pullapprove pullapprove bot requested a review from jelbourn August 30, 2024 22:34
@angular-robot angular-robot bot added area: docs Related to the documentation area: docs-infra Angular.dev application and infrastructure labels Aug 30, 2024
@ngbot ngbot bot added this to the Backlog milestone Aug 30, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 30, 2024 •
edited
Loading

Deployed adev-preview for 144d2cc to: https://ng-dev-previews-fw--pr-angular-angular-57614-adev-prev-ofhwpqus.web.app

Note: As new commits are pushed to this pull request, this link is updated after the preview is rebuilt.

@JeanMeche JeanMeche requested a review from twerske August 30, 2024 23:02
@JeanMeche JeanMeche added the action: review The PR is still awaiting reviews from at least one requested reviewer label Aug 30, 2024
@mvdluit mvdluit force-pushed the adev-filter-api-status branch 4 times, most recently from 4c6cb79 to 4faeaa2 Compare September 2, 2024 07:32
@mvdluit
Copy link
Contributor Author

mvdluit commented Sep 2, 2024

Fixed a visual bug: when dropdown was positioned over the items section, it would bleed through the dropdown background (visibible both in light and dark mode).

adev-dropdown

PR is ready for review now.

@mvdluit
Copy link
Contributor Author

mvdluit commented Sep 25, 2024

@jelbourn @twerske is it possible to get this reviewed? We're seeing more questions on Discord about being able to see which references are stable or in developer preview and there's currently no easy way to do that on adev.

@JeanMeche JeanMeche requested review from MarkTechson and removed request for twerske September 25, 2024 13:53
@JeanMeche
Copy link
Member

@mvdluit Could you please rebase the PR, so Mark can have a look at the preview ?

@mvdluit
docs(docs-infra): add status filter to api reference overview
144d2cc 
add a status filter on the api reference overview page to filter on status (all|stable|deprecated|developer-preview|experimental)
@mvdluit mvdluit force-pushed the adev-filter-api-status branch from 4faeaa2 to 144d2cc Compare September 25, 2024 14:44
@mvdluit
Copy link
Contributor Author

mvdluit commented Sep 25, 2024

@mvdluit Could you please rebase the PR, so Mark can have a look at the preview ?

Done

@MarkTechson
Copy link
Contributor

Currently discussing some logistics with the team regarding this one.

@mvdluit
Copy link
Contributor Author

mvdluit commented Oct 10, 2024

Hi @MarkTechson, are there any specific concerns with this PR? Please let me know if there's anything I can do to progress this PR.

@MarkTechson
Copy link
Contributor

Hi @MarkTechson, are there any specific concerns with this PR? Please let me know if there's anything I can do to progress this PR.

Thanks for checking in. Right now there are some UX issues on this page that we are discussing internally that we want to resolve so that a feature like this can have its true intent to make the experience better for users. I'll update this PR as soon as we have more information on next steps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jelbourn jelbourn Awaiting requested review from jelbourn

@MarkTechson MarkTechson Awaiting requested review from MarkTechson

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
action: review The PR is still awaiting reviews from at least one requested reviewer adev: preview area: docs Related to the documentation area: docs-infra Angular.dev application and infrastructure
Projects
None yet
Milestone
Backlog
Development

Successfully merging this pull request may close these issues.
4 participants
@mvdluit @JeanMeche @MarkTechson @josephperrott