56 Commits

Author SHA1 Message Date
Jack Hsu
28b48ad1f3
docs(misc): update URls that should point to intro pages rather than API index pages (#31531)
This PR fixes an issue introduced when we removed `/nx-api` pages:
https://github.com/nrwl/nx/pull/31453.

Most of the old `/nx-api/<plugin>` URLs should now go to
`/technologies/<plugin>/introduction`, since those pages contain what
was on the previous "overview" pages.

The only exception are places where we explicitly link to
`.../api/{generators,executors,migrations}` URLs, and the following
three blog posts that we want users to land on the API index.

-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-03-29-the-react-cli-you-always-wanted-but-didnt-know-about.md?plain=1#L132
(https://nx.dev/blog/the-react-cli-you-always-wanted-but-didnt-know-about)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-04-08-what-is-new-in-nx-13-10.md?plain=1#L245
(https://nx.dev/blog/what-is-new-in-nx-13-10)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-05-02-nx-v14-is-out-here-is-all-you-need-to-know.md?plain=1#L253
(https://nx.dev/blog/nx-v14-is-out-here-is-all-you-need-to-know)
2025-06-10 15:08:29 -04:00
Jack Hsu
66eaf2fc74
docs(misc): remove /nx-api pages (#31453)
This PR removes the `/nx-api` pages from `nx-dev`. They are already
redirected from `/nx-api` to either `/technologies` or
`/reference/core-api` URLs.

e.g. `/nx-api/nx` goes to `/reference/core-api/nx` and `/nx-api/react`
goes to `/technologies/react/api`

**Changes**:
- Remove old `nx-api.json` from being generated in
`scripts/documentation/generators/generate-manifests.ts` -- this was
used to generate the sitemap
- Remove `pages/nx-api` from Next.js app since we don't need them
- Remove workaround from link checker
`scripts/documentation/internal-link-checker.ts` -- the angular
rspack/rsbuild and other workarounds are gone now that they are proper
docs in `map.json`
- Update Powerpack/Remote Cache reference docs to exclude API documents
(since they are duplicated in the Intro page) --
`nx-dev/models-document/src/lib/mappings.ts`
- All content in `docs` have been updated with new URL structure

**Note:** Redirects are already handled, and Claude Code was used to
verify the updated `docs/` URLs (see report below). The twelve 404s
links were updated by hand.

## Verification Report

https://gist.github.com/jaysoo/c7863fe7e091cb77929d1976165c357a
2025-06-04 16:57:01 -04:00
Caleb Ukle
4f57f01d01
docs(core): move plugin api docs to tech plugin guides (#31402)
# before

plugin api docs where stuck in `api` section which doesn't make sense

# after

move plugin api docs into `guides` section and add redirect for better
discoverability
2025-06-03 13:43:24 -04:00
Juri Strumpflohner
b51676a89a
docs(core): restructure guides into technologies sections (#31288)
Updates the docs structure, navigation etc to be easier + better suited
for showing Nx technology support beyond just TS.

**Notes:**

- API (`/nx-api`) tab is removed from the navigation (i.e. menu bar),
but pages still remain for now until we update references in `*.md`
files.
- Redirects are set up `/nx-api` to go to their respect new location
e.g. `/technologies` or `/reference/core-api`
- Old URLs still exist in the sitemap for now, but majority of them will
be redirected -- a follow-up PR can remove them.

**Preview:**
https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs

---------

Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
2025-05-29 14:55:34 -04:00
Miroslav Jonaš
d4ebf82ac8
feat(core): add filter for git checkouts in generated pipelines and docs (#30547)
This PR adds Git filter `tree:0` to Azure and GitHub pipelines to avoid
fetching the full history content because of the affected command.

The change is made to:
- `ci-workflow` generator in `workspace` project for Azure and GitHub
- `ci-workflow` generator in `gradle` project for GitHub
- this repo's  main pipeline -`ci.yaml`
- all documentation occurrences where fetch depth 0 is used on Azure or
GitHub

More info on reasoning here:
https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2025-04-10 11:33:31 +02:00
Juri
437bad4aac docs(misc): add description frontmatter for better SEO 2025-03-04 16:58:14 +01:00
Isaac Mann
471536cb38
docs(core): remove integrated docs (#28228)
- Move the integrated vs. package-based concept page to the deprecated
section
- Remove the integrated project in package-based repo recipe
- Remove the package-based project in integrated repo recipe
- Rename standalone to integrated recipe
- Update references to integrated or package-based terms in tutorials
2024-10-01 23:22:11 -04:00
Isaac Mann
332a20fd08
docs(core): updates for login/logout (#27838)
Replaces references to `nxCloudAccessToken` with `nxCloudId`
Adds login/logout to the commands landing page
2024-09-09 16:14:57 -04:00
Jack Hsu
ec5b04fb82
docs(core): move "nx connect" earlier in CI section for standalone/monorepo tutorials (#26845)
We're making an enhancement to `nx g ci-workflow` such that when the
workspace is already connected to Nx Cloud, we'll enable distribution in
the workflow file, rather than having them commented out. For the flow
of the tutorial, it makes more sense to do `nx connect` first so things
are set up correctly without user intervention.

Note: I left the "Make sure the following line is uncommented" for
distribution because older versions will still leave it uncommented.

Example:
https://nx-dev-git-docs-tutorials-update-nrwl.vercel.app/getting-started/tutorials/angular-monorepo-tutorial

---------

Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
2024-07-19 13:43:05 -04:00
Isaac Mann
c412bf2d5e
docs(core): ci section for tutorials (#24728)
- update CI section in tutorials to not include screenshots of
onboarding flow
- add CI section to `nx init` tutorials
2024-05-22 11:54:15 -04:00
Isaac Mann
33008f25b5
docs(core): clean up more concepts section (#22957) 2024-04-24 10:28:53 +02:00
Leosvel Pérez Espinosa
27094c5f4b
docs(angular): remove manual migration guide (#22723) 2024-04-09 17:40:35 +02:00
Isaac Mann
d75318bef4
docs(core): remove old version warnings (#22704)
Co-authored-by: Leosvel Pérez Espinosa <leosvel.perez.espinosa@gmail.com>
2024-04-09 09:40:50 -04:00
Isaac Mann
5f255c5a43
docs(core): editor setup in getting started (#22416)
Co-authored-by: Leosvel Pérez Espinosa <leosvel.perez.espinosa@gmail.com>
2024-04-02 11:56:42 -04:00
Isaac Mann
61436a64ef
docs(core): inferred targets (#21167)
Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
Co-authored-by: Colum Ferry <cferry09@gmail.com>
Co-authored-by: Emily Xiong <xiongemi@gmail.com>
Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com>
Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
Co-authored-by: Victor Savkin <mail@vsavkin.com>
Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
2024-02-03 00:14:05 -05:00
Isaac Mann
d1e842f827
feat(nx-dev): rename nx-cloud tab to CI (#20476) 2023-11-30 08:24:24 -05:00
Leosvel Pérez Espinosa
25d6ec3a92
feat(angular): support angular v17 (#19689) 2023-11-07 15:45:42 -05:00
Isaac Mann
457bbcbe57
docs(core): nx cloud features section (#20043) 2023-11-07 08:40:29 -05:00
Juri
73c15d5987 docs(angular): some improvements to the Nx vs Angular CLI page 2023-11-01 15:23:39 +01:00
Isaac Mann
d1fe398ea0
docs(core): packages to api (#19281) 2023-09-22 14:24:35 -04:00
Juri
799ae13d74 docs(angular): update Nx and Angular CLI page with more details and video embed 2023-09-14 14:29:07 +02:00
Juri
dcecb6f46a docs(core): cleanup youtube tags 2023-07-31 11:19:07 +02:00
Miroslav Jonas
09b70521e7 docs(nx-dev): make recipes to nx section 2023-07-25 15:09:46 +02:00
Miroslav Jonas
42a06b67d2 feat(nx-dev): restructure recipes 2023-07-25 15:09:46 +02:00
Miroslav Jonaš
331707d6eb
docs(nx-dev): make more concepts submenu (#18266) 2023-07-24 14:20:48 +00:00
Isaac Mann
afa5eb59fa
docs(core): document the @nrwl => @nx rescope (#16403)
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
2023-04-27 18:14:59 -04:00
Victor Savkin
1fb9edc460 feat(core): support both @nrwl/nx-cloud and nx-cloud 2023-04-13 10:59:31 -04:00
Leosvel Pérez Espinosa
e5b48ac956
cleanup(misc): remove add-nx-to-monorepo package (#15498) 2023-04-12 16:41:17 +01:00
Isaac Mann
83b05a6e2f
docs(core): split angular migrate guide (#15807) 2023-04-11 12:25:39 -07:00
Leosvel Pérez Espinosa
9cb6005d0a
docs(angular): update migration from angular cli docs to reflect angular 14 support on latest nx (#14774) 2023-02-14 00:04:17 -05:00
Colum Ferry
a5707c8b75
feat(angular): remove decorate-angular-cli (#14226) 2023-01-09 21:34:09 +00:00
Benjamin Cabanes
19fd40ddc7
docs(nxdev): refactor docs sources generation and app consumption (#13834) 2022-12-19 18:59:50 +00:00
Isaac Mann
dfd347cd39
docs(core): old angular migrations warning (#13828) 2022-12-14 19:34:55 +00:00
Isaac Mann
994f3f84ce
docs(core): update angular to nx guide (#13519)
Co-authored-by: Zack DeRose <zack.derose@gmail.com>
2022-12-06 09:50:45 -05:00
Leosvel Pérez Espinosa
32635992e1
docs(angular): recommend using the latest version of nx for the latest version of angular (#12731) 2022-10-21 10:27:23 -07:00
Benjamin Cabanes
1e5297edfc
docs(core): use shell code blocks (#12587) 2022-10-13 21:25:40 +00:00
Benjamin Cabanes
3de46d5dd6
docs(core): reformat doc with better code fences (#12581) 2022-10-13 19:31:42 +00:00
Juri
94ed7ce9b2 docs(angular): add videos for Angular migration scenarios 2022-09-06 21:17:36 +02:00
Isaac Mann
e717660102
docs(nx-dev): diataxis restructure (#11649)
* docs(nxdev): restructure docs to diataxis style

* docs(nxdev): cleanup

* docs(nxdev): fix links

* chore(nxdev): format

* docs(nxdev): fix broken images

* docs(nxdev): fix links

* docs(nxdev): fix links

* docs(nxdev): fix links

* docs(nxdev): tweaks

* docs(nxdev): redirect rules

* docs(nxdev): fixes
2022-08-29 08:36:55 -04:00
Benjamin Cabanes
21a7d2c181
docs(core): enhance markdown markup (#10969) 2022-07-04 16:09:14 +00:00
Benjamin Cabanes
778f13fdaf
docs(nxdev): improve markdown capabilities (#10965) 2022-06-30 15:30:38 -04:00
Leosvel Pérez Espinosa
46a075c0b0
docs(angular): update angular cli migration docs with information about multiple projects support (#10466) 2022-05-25 15:12:21 +01:00
Zachary DeRose
b5ce8bbfaf
docs(angular): updating script changes per Nx updates (#9715)
* docs(angular): updating script changes per Nx updates

* docs(angular): update youtube link
2022-04-06 11:36:48 -07:00
Zachary DeRose
05de3906c1
docs(angular): migration from nx console section added (#9691)
* docs(angular): migration from nx console section added

* docs(angular): adjusting video dimensions

* docs(angular): moving from nx console section to bottom
2022-04-05 14:15:42 -07:00
Leosvel Pérez Espinosa
8072007631
docs(angular): fix typo in the migration from angular cli docs (#9424) 2022-03-21 11:01:32 +00:00
Jason Jean
2d57ac05ac
docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular (#9288) (#9401)
* docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular

Co-authored-by: Jason Jean <jasonjean1993@gmail.com>

Co-authored-by: Leosvel Pérez Espinosa <leosvel.perez.espinosa@gmail.com>
2022-03-18 17:50:07 -04:00
Jason Jean
95886bfdff
Revert "docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular (#9288)" (#9400)
This reverts commit 0a88ba473fbb7f8bd8c5794b72a404e7bf41820f.
2022-03-18 17:25:08 -04:00
Leosvel Pérez Espinosa
0a88ba473f
docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular (#9288)
* docs(angular): update angular cli migration docs to reflect the generator relocation to @nrwl/angular

* chore: add @

* chore: add @

Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
2022-03-18 17:23:07 -04:00
Leosvel Pérez Espinosa
bf513b1aad
docs(angular): update angular cli migration docs (#9176) 2022-03-03 13:00:11 +00:00
Leosvel Pérez Espinosa
615955afec
feat(angular): support migrating angular cli workspaces using cypress for e2e tests (#9105) 2022-02-28 11:03:09 +00:00