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(nxdev): support packages schemas metadata & discoverability #9383

Merged
merged 1 commit into from
Mar 24, 2022
Merged

docs(nxdev): support packages schemas metadata & discoverability #9383

merged 1 commit into from
Mar 24, 2022

Conversation

bcabanes
Copy link
Member

@bcabanes bcabanes commented Mar 17, 2022 •
edited
Loading

This brings a completely rewritten way to handle Nx package shemas for nx.dev, from the their generation to their handling on the website.

Change log:

  • New URLs schemes, that will enable discoverability by packages and then by types (executors/generators). We are able to automatically list packages and their related schemas in dedicates pages /pacakges/{package-name}.
  • Redirections have been added to make sure all the previous URLs redirects to the new URL scheme.
  • Passed through all the schematics to add missing properties, format descriptions etc... They are now more uniform.
  • We are not generating multiple markdown files anymore, but metadata for each of the packages with all their executors & generators schemas, with links and paths resolved, augmented with their own metadata for each one of them.
  • The UI for the presentation of properties as been slightly updated, for a cleaner look.
  • We can now directly go to the Github code of the package with a link from the page.
  • We can now directly see the current schema for the executor/generator on Github with a link from the page.
  • We are now supporting the resolution of references, meaning we support and infer types for each properties.
  • The support for Object is present and as well as composite types with: anyOf, manyOf, not, oneOf...
  • We are now supporting examples as well, for each properties as well as for an executor/generator.
  • We supported references, we can navigate to the Object property definition with a shareable link.
  • The navigation is supported with new breadcrumbs component for easier navigation and knowing where to go back from.
  • We show now an “Options playground” for executors that allows the user to see and interact with the supported properties via a VSCode like editor.
  • The editor is supporting intellisense and type validation on each properties for easier discoverability.
  • We can now set presets on executors to show in the UI for even easier copy and past of specific or recurring use case for that executor.

@nx-cloud
Copy link

nx-cloud bot commented Mar 17, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI ran the following commands for commit 24cbcd4. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 7 targets

Sent with 💌 from NxCloud.

@vercel
Copy link

vercel bot commented Mar 17, 2022 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/nrwl/nx-dev/JCwQe4LKLmhfQYtgsKZqi62Ldk9W
✅ Preview: https://nx-dev-git-fork-bcabanes-docs-nxdevapi-schema-explorer-nrwl.vercel.app

@bcabanes bcabanes added the scope: docs Issues related to generic docs label Mar 17, 2022
@bcabanes bcabanes self-assigned this Mar 17, 2022
@bcabanes bcabanes requested review from vsavkin and jaysoo March 17, 2022 19:25
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from fb255ab to ac5974d Compare March 17, 2022 19:39
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from ac5974d to 5e591c8 Compare March 17, 2022 20:09
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 5e591c8 to d2e5d88 Compare March 17, 2022 20:15
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from d2e5d88 to 15a7035 Compare March 17, 2022 21:01
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 15a7035 to 32cf140 Compare March 17, 2022 21:14
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 32cf140 to 9b082bc Compare March 17, 2022 23:01
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 9b082bc to 41b4aef Compare March 17, 2022 23:15
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 41b4aef to 0d34cfc Compare March 19, 2022 19:08
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 0d34cfc to 8523bcf Compare March 19, 2022 19:50
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 8523bcf to fbe5a56 Compare March 21, 2022 14:56
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from fbe5a56 to 40edf81 Compare March 21, 2022 15:28
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 40edf81 to 17c49cb Compare March 21, 2022 17:30
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 8155b42 to b1bb4f3 Compare March 22, 2022 15:02
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from b1bb4f3 to 9176c16 Compare March 22, 2022 16:36
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 9176c16 to ff83406 Compare March 22, 2022 19:31
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from ff83406 to 1ccb5c6 Compare March 22, 2022 20:02
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 1ccb5c6 to f47c43d Compare March 22, 2022 22:15
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from f47c43d to c48b8cb Compare March 23, 2022 13:38
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from c48b8cb to 441a30d Compare March 23, 2022 18:08
@bcabanes bcabanes marked this pull request as ready for review March 23, 2022 18:36
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 441a30d to 96c46ac Compare March 23, 2022 20:01
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 96c46ac to 6fbed0c Compare March 24, 2022 13:25
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 6fbed0c to 3ca9e73 Compare March 24, 2022 14:21
@bcabanes
docs(nxdev): support package schemas metadata & discoverability
24cbcd4 
This brings a completely rewritten way to handle Nx package schemas for
nx.dev, from the their generation to their handling on the website.

Changelog:
- New URLs schemes, that will enable discoverability by packages and then by types (executors/generators). _We will be able to automatically list packages and their related schemas in dedicates pages._
- Redirections have been added to make sure all the previous URLs redirects to the new URL scheme.
- Passed through all the schematics to add missing properties, format descriptions etc... They are now more uniform.
- We are not generating multiple markdown files anymore, but metadata for each of the packages with all their executors & generators schemas, with links and paths resolved, augmented with their own metadata for each one of them.
- The UI for the presentation of properties as been slightly updated, for a cleaner look.
- We can now directly go to the Github code of the package with a link from the page.
- We can now directly see the current schema for the executor/generator on Github with a link from the page.
- We are now supporting the resolution of references, meaning we support and infer types for each properties.
- The support for `Object` is present and as well as composite types with: `anyOf`, `manyOf`, `not`, `oneOf`...
- We are now supporting examples as well, for each properties as well as for an executor/generator.
- We supported references, we can navigate to the Object property definition with a shareable link.
- The navigation is supported with new breadcrumbs component for easier navigation and knowing where to go back from.
- We show now an “Options playground” for executors that allows the user to see and interact with the supported properties via a VSCode like editor.
- The editor is supporting intellisense and type validation on each properties for easier discoverability.
- We can now set presets on executors to show in the UI for even easier copy and past of specific or recurring use case for that executor.
@bcabanes bcabanes force-pushed the docs/nxdev/api-schema-explorer branch from 3ca9e73 to 24cbcd4 Compare March 24, 2022 14:39
@bcabanes bcabanes merged commit 6dae32c into nrwl:master Mar 24, 2022
@bcabanes bcabanes deleted the docs/nxdev/api-schema-explorer branch March 24, 2022 16:00
sidmonta pushed a commit to sidmonta/nx that referenced this pull request Apr 2, 2022
@bcabanes @sidmonta
docs(nxdev): support packages schemas metadata & discoverability (nrw…
a879aac 
…l#9383)
@github-actions
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@vsavkin vsavkin Awaiting requested review from vsavkin vsavkin is a code owner

@jaysoo jaysoo Awaiting requested review from jaysoo jaysoo is a code owner

Assignees

@bcabanes bcabanes

Labels
scope: docs Issues related to generic docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@bcabanes