docs(core): fix search indexing errors (#28858)

Fix search indexing errors
This commit is contained in:
Isaac Mann 2024-11-11 14:15:17 -05:00 committed by GitHub
parent f3889e4873
commit 37e31bea57
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 15 additions and 167 deletions

View File

@ -15,7 +15,7 @@ When Victor Savkin and I left Google to start this company in December 2016, we
![](/blog/images/2022-11-17/WIkl00uLsSt6p6dmQbIA0g.avif)
[Nx Cloud](/nx-cloud) has also seen a significant uptake in adoption, thanks in large part due to the addition of [Distributed Task Execution](/ci/concepts/parallelization-distribution) last year. With the combination of Distributed Task Execution and Distributed Caching, Nx Cloud is having a massive impact on the time it takes to validate and merge pull requests, drastically reducing product time-to-market. There are now more than 100k connected Nx Workspaces on nx.app. With Nx Cloud, Nx and Lerna workspaces can drastically reduce build times by letting Nx Cloud manage task cache distribution, and optimal distribution of tasks across many machines using Nxs deep understanding of project relationships and task timings. Weve determined that Nx and Nx Cloud have [saved over 250 years of compute time](blog/helping-the-environment-by-saving-two-centuries-of-compute-time) since we started measuring.
[Nx Cloud](/nx-cloud) has also seen a significant uptake in adoption, thanks in large part due to the addition of [Distributed Task Execution](/ci/concepts/parallelization-distribution) last year. With the combination of Distributed Task Execution and Distributed Caching, Nx Cloud is having a massive impact on the time it takes to validate and merge pull requests, drastically reducing product time-to-market. There are now more than 100k connected Nx Workspaces on nx.app. With Nx Cloud, Nx and Lerna workspaces can drastically reduce build times by letting Nx Cloud manage task cache distribution, and optimal distribution of tasks across many machines using Nxs deep understanding of project relationships and task timings. Weve determined that Nx and Nx Cloud have [saved over 250 years of compute time](/blog/helping-the-environment-by-saving-two-centuries-of-compute-time) since we started measuring.
![](/blog/images/2022-11-17/ysWZ8fn2K3m3GjCNGRwshw.avif)

View File

@ -19,7 +19,7 @@ However, until now, it has only supported Client-Side Rendering (CSR). Essential
> [What is server-side rendering: definition, benefits and risks](https://solutionshub.epam.com/blog/post/what-is-server-side-rendering)
Since [version 15.4](blog/nx-15-4-vite-4-support-a-new-nx-watch-command-and-more), Nx now offers Module Federation with support for SSR! 🎉
Since [version 15.4](/blog/nx-15-4-vite-4-support-a-new-nx-watch-command-and-more), Nx now offers Module Federation with support for SSR! 🎉
Now we can get both, the benefits of Module Federation and SSR in our Nx Workspaces!

View File

@ -110,7 +110,7 @@ To set it up, just click on the button in the Nx Console cloud view and follow t
## Learn more
- 🧠 [Nx Docs](/getting-started/intro)
- 👩‍💻 [Nx GitHub](<[https://github.com/nrwl/nx](https://github.com/nrwl/nx)>)
- 🎮 [Nx Console GitHub](<[https://github.com/nrwl/nx-console](https://github.com/nrwl/nx-console)>)
- 👩‍💻 [Nx GitHub](https://github.com/nrwl/nx)
- 🎮 [Nx Console GitHub](https://github.com/nrwl/nx-console)
- 💬 [Nx Official Discord Server](https://go.nx.dev/community)
- 📹 [Nx Youtube Channel](<[https://www.youtube.com/@nxdevtools](https://www.youtube.com/@nxdevtools)>)
- 📹 [Nx Youtube Channel](https://www.youtube.com/@nxdevtools)

View File

@ -128,7 +128,7 @@ const lockFile = createLockFile(packageJson);
// save files using e.g. `fs.writeFileSync`
```
Stay tuned for a more in-depth blog post coming soon to [our blog](blog).
Stay tuned for a more in-depth blog post coming soon to [our blog](/blog).
## Storybook 7.0 beta support

View File

@ -39,7 +39,7 @@ This command will guide you through the setup. We recently introduced a [new Hob
## Learn More
- [Nx on CI](/ci)
- [Nx on CI](/ci/intro/ci-with-nx)
- [Task Distribution with Nx Agents](/ci/features/distribute-task-execution)
- [Automated e2e Test Splitting](/ci/features/split-e2e-tasks)
- [X/Twitter](https://twitter.com/nxdevtools) -- [LinkedIn](https://www.linkedin.com/company/nrwl/)

View File

@ -479,7 +479,7 @@ For more information about Zephyr Cloud I highly recommend checking out their [d
## Learn More
- [Nx on CI](/ci)
- [Nx on CI](/ci/intro/ci-with-nx)
- [Task Distribution with Nx Agents](/ci/features/distribute-task-execution)
- [Automated e2e Test Splitting](/ci/features/split-e2e-tasks)
- [X/Twitter](https://twitter.com/nxdevtools) -- [LinkedIn](https://www.linkedin.com/company/nrwl/)

View File

@ -1,6 +1,6 @@
# Nx 15.4
[Read the 15.4 release blog post](https://blog.nrwl.io/nx-15-4-vite-4-support-a-new-nx-watch-command-and-more-77cbf6c9a711)
[Read the 15.4 release blog post](/blog/nx-15-4-vite-4-support-a-new-nx-watch-command-and-more)
{% youtube
src="https://www.youtube.com/embed/G02THNy3PcE"

View File

@ -51,7 +51,7 @@
"componentDir",
"componentFileName"
],
"examplesFile": "{% callout type=\"caution\" title=\"Can I use component testing?\" %}\nAngular component testing with Nx requires **Cypress version 10.7.0** and up.\n\nYou can migrate with to v11 via the [migrate-to-cypress-11 generator](/nx-api/cypress/generators/migrate-to-cypress-11).\n\nThis generator is for Cypress based component testing.\n\nIf you're wanting to create Cypress tests for a Storybook story, then check out the [component-cypress-spec generator docs](/nx-api/angular/generators/component-cypress-spec)\n\nIf you're wanting to create Storybook stories for a component, then check out the [stories generator docs](/nx-api/angular/generators/stories) or [component-story generator docs](/nx-api/angular/generators/component-cypress-spec)\n{% /callout %}\n\nThis generator is used to create a Cypress component test file for a given Angular component.\n\n```shell\nnx g @nx/angular:component-test --project=my-cool-angular-project --componentName=CoolBtnComponent --componentDir=src/cool-btn --componentFileName=cool-btn.component\n```\n\nTest file are generated with the `.cy.ts` suffix. this is to prevent colliding with any existing `.spec.` files contained in the project.\n\nIt's currently expected the generated `.cy.ts` file will live side by side with the component. It is also assumed the project is already setup for component testing. If it isn't, then you can run the [cypress-component-project generator](/nx-api/angular/generators/cypress-component-configuration) to set up the project for component testing.\n",
"examplesFile": "{% callout type=\"caution\" title=\"Can I use component testing?\" %}\nAngular component testing with Nx requires **Cypress version 10.7.0** and up.\n\nYou can migrate with to v11 via the [migrate-to-cypress-11 generator](/nx-api/cypress/generators/migrate-to-cypress-11).\n{% /callout %}\n\nThis generator is used to create a Cypress component test file for a given Angular component.\n\n```shell\nnx g @nx/angular:component-test --project=my-cool-angular-project --componentName=CoolBtnComponent --componentDir=src/cool-btn --componentFileName=cool-btn.component\n```\n\nTest file are generated with the `.cy.ts` suffix. this is to prevent colliding with any existing `.spec.` files contained in the project.\n\nIt's currently expected the generated `.cy.ts` file will live side by side with the component. It is also assumed the project is already setup for component testing. If it isn't, then you can run the [cypress-component-project generator](/nx-api/angular/generators/cypress-component-configuration) to set up the project for component testing.\n",
"presets": []
},
"description": "Creates a cypress component test file for a component.",

View File

@ -30,7 +30,7 @@
}
},
"required": ["project", "componentPath"],
"examplesFile": "{% callout type=\"caution\" title=\"Can I use component testing?\" %}\nReact component testing with Nx requires **Cypress version 10** and up.\n\nYou can migrate with to v11 via the [migrate-to-cypress-11 generator](/nx-api/cypress/generators/migrate-to-cypress-11).\n\nThis generator is for Cypress based component testing.\n\nIf you're wanting to create Cypress tests for a Storybook story, then check out the [component-cypress-spec generator docs](/nx-api/react/generators/component-cypress-spec)\n\nIf you're wanting to create Storybook stories for a component, then check out the [stories generator docs](/nx-api/react/generators/stories) or [component-story generator docs](/nx-api/react/generators/component-cypress-spec)\n\n{% /callout %}\n\nThis generator is used to create a Cypress component test file for a given React component.\n\n```shell\nnx g @nx/react:component-test --project=my-cool-react-project --componentPath=src/my-fancy-button.tsx\n```\n\nTest file are generated with the `.cy.` suffix. this is to prevent colliding with any existing `.spec.` files contained in the project.\n\nIt's currently expected the generated `.cy.` file will live side by side with the component. It is also assumed the project is already setup for component testing. If it isn't, then you can run the [cypress-component-project generator](/nx-api/react/generators/cypress-component-configuration) to set up the project for component testing.\n",
"examplesFile": "{% callout type=\"caution\" title=\"Can I use component testing?\" %}\nReact component testing with Nx requires **Cypress version 10** and up.\n\nYou can migrate with to v11 via the [migrate-to-cypress-11 generator](/nx-api/cypress/generators/migrate-to-cypress-11).\n\nThis generator is for Cypress based component testing.\n\nIf you're wanting to create Storybook stories for a component, then check out the [stories generator docs](/nx-api/react/generators/stories)\n\n{% /callout %}\n\nThis generator is used to create a Cypress component test file for a given React component.\n\n```shell\nnx g @nx/react:component-test --project=my-cool-react-project --componentPath=src/my-fancy-button.tsx\n```\n\nTest file are generated with the `.cy.` suffix. this is to prevent colliding with any existing `.spec.` files contained in the project.\n\nIt's currently expected the generated `.cy.` file will live side by side with the component. It is also assumed the project is already setup for component testing. If it isn't, then you can run the [cypress-component-project generator](/nx-api/react/generators/cypress-component-configuration) to set up the project for component testing.\n",
"presets": []
},
"description": "Generate a Cypress component test for a React component",

View File

@ -19,7 +19,6 @@
"add-linting",
"application",
"component",
"component-cypress-spec",
"component-story",
"component-test",
"downgrade-module",
@ -278,7 +277,6 @@
"storybook-configuration",
"component-story",
"stories",
"component-cypress-spec",
"hook",
"host",
"remote",

View File

@ -200,7 +200,6 @@ NX Capabilities in @nx/angular:
add-linting : Adds linting configuration to an Angular project.
application : Creates an Angular application.
component : Generate an Angular Component.
component-cypress-spec : Creates a Cypress spec for a UI component that has a story.
component-story : Creates a stories.ts file for a component.
component-test : Creates a cypress component test file for a component.
convert-tslint-to-eslint : Converts a project from TSLint to ESLint.

View File

@ -250,7 +250,6 @@ NX Capabilities in @nx/react:
storybook-configuration : Set up storybook for a React app or library.
component-story : Generate storybook story for a React component
stories : Create stories/specs for all components declared in an app or library.
component-cypress-spec : Create a Cypress spec for a UI component that has a story.
hook : Create a hook.
cypress-component-configuration : Setup Cypress component testing for a React project
component-test : Generate a Cypress component test for a React component

View File

@ -351,7 +351,6 @@ redux : Create a Redux slice for a project.
storybook-configuration : Set up storybook for a React app or library.
component-story : Generate storybook story for a React component
stories : Create stories/specs for all components declared in an app or library.
component-cypress-spec : Create a Cypress spec for a UI component that has a story.
hook : Create a hook.
host : Generate a host react application
remote : Generate a remote react application

View File

@ -66,8 +66,6 @@ const schemaUrls = {
'/packages/angular/executors/dev-server',
'/react/application': '/packages/react/generators/application',
'/react/component': '/packages/react/generators/component',
'/react/component-cypress-spec':
'/packages/react/generators/component-cypress-spec',
'/react/component-story': '/packages/react/generators/component-story',
'/react/library': '/packages/react/generators/library',
'/react/redux': '/packages/react/generators/redux',

View File

@ -1,107 +1,6 @@
'use client';
import { Menu, MenuItem, MenuSection } from '@nx/nx-dev/models-menu';
import { Menu } from '@nx/nx-dev/models-menu';
import { Sidebar, SidebarMobile } from './sidebar';
import { useMemo } from 'react';
// TODO(jack): Remove this rspack modification once we move rspack into main repo (when stable).
const rspackSection = {
id: 'rspack',
name: 'rspack',
itemList: [
{
id: 'documents',
path: '/nx-api/rspack/documents',
name: 'documents',
children: [
{
name: 'Overview of the Nx Rspack plugin',
path: '/nx-api/rspack/documents/overview',
id: 'overview',
isExternal: false,
children: [],
disableCollapsible: false,
},
{
name: 'Rspack plugins',
path: '/nx-api/rspack/documents/rspack-plugins',
id: 'rspack-plugins',
isExternal: false,
children: [],
disableCollapsible: false,
},
{
name: 'How to configure Rspack in your Nx workspace',
path: '/nx-api/rspack/documents/rspack-config-setup',
id: 'rspack-config-setup',
isExternal: false,
children: [],
disableCollapsible: false,
},
],
isExternal: false,
disableCollapsible: false,
},
{
id: 'executors',
path: '/nx-api/rspack/executors',
name: 'executors',
children: [
{
id: 'rspack',
path: '/nx-api/rspack/executors/rspack',
name: 'rspack',
children: [],
isExternal: false,
disableCollapsible: false,
},
{
id: 'dev-server',
path: '/nx-api/rspack/executors/dev-server',
name: 'dev-server',
children: [],
isExternal: false,
disableCollapsible: false,
},
],
isExternal: false,
disableCollapsible: false,
},
{
id: 'generators',
path: '/nx-api/rspack/generators',
name: 'generators',
children: [
{
id: 'init',
path: '/nx-api/rspack/generators/init',
name: 'init',
children: [],
isExternal: false,
disableCollapsible: false,
},
{
id: 'configuration',
path: '/nx-api/rspack/generators/configuration',
name: 'configuration',
children: [],
isExternal: false,
disableCollapsible: false,
},
{
id: 'application',
path: '/nx-api/rspack/generators/application',
name: 'application',
children: [],
isExternal: false,
disableCollapsible: false,
},
],
isExternal: false,
disableCollapsible: false,
},
],
hideSectionHeader: false,
};
export function SidebarContainer({
menu,
@ -112,33 +11,12 @@ export function SidebarContainer({
navIsOpen: boolean;
toggleNav: (value: boolean) => void;
}): JSX.Element {
// TODO(jack): Remove this rspack modification once we move rspack into main repo (when stable).
const menuWithRspack = useMemo(() => {
const storybookIdx = menu.sections.findIndex((s) => s.id === 'storybook');
const sections =
storybookIdx > -1
? [
...menu.sections.slice(0, storybookIdx),
rspackSection,
...menu.sections.slice(storybookIdx),
]
: menu.sections;
return {
...menu,
sections,
};
}, [menu]);
return (
<div id="sidebar" data-testid="sidebar">
<SidebarMobile
menu={menuWithRspack}
toggleNav={toggleNav}
navIsOpen={navIsOpen}
/>
<SidebarMobile menu={menu} toggleNav={toggleNav} navIsOpen={navIsOpen} />
<div className="hidden h-full w-72 flex-col border-r border-slate-200 md:flex dark:border-slate-700 dark:bg-slate-900">
<div className="relative flex flex-grow overflow-y-scroll p-4">
<Sidebar menu={menuWithRspack} />
<Sidebar menu={menu} />
</div>
{/*<div className="relative flex flex-col space-y-1 border-t border-slate-200 px-4 py-2 dark:border-slate-700">*/}
{/* // another section.*/}

View File

@ -1,15 +0,0 @@
## Examples
{% tabs %}
{% tab label="Basic Usage" %}
Create a cypress spec for a component that is set up with Storybook.
```bash
nx g @nx/angular:component-cypress-spec --componentName=MyButtonComponent --componentPath=libs/ui/src/lib/button/button.component.ts --componentFileName=button.component --projectName=ui --projectPath=libs/ui
```
{% /tab %}
{% /tabs %}

View File

@ -2,12 +2,6 @@
Angular component testing with Nx requires **Cypress version 10.7.0** and up.
You can migrate with to v11 via the [migrate-to-cypress-11 generator](/nx-api/cypress/generators/migrate-to-cypress-11).
This generator is for Cypress based component testing.
If you're wanting to create Cypress tests for a Storybook story, then check out the [component-cypress-spec generator docs](/nx-api/angular/generators/component-cypress-spec)
If you're wanting to create Storybook stories for a component, then check out the [stories generator docs](/nx-api/angular/generators/stories) or [component-story generator docs](/nx-api/angular/generators/component-cypress-spec)
{% /callout %}
This generator is used to create a Cypress component test file for a given Angular component.

View File

@ -5,9 +5,7 @@ You can migrate with to v11 via the [migrate-to-cypress-11 generator](/nx-api/cy
This generator is for Cypress based component testing.
If you're wanting to create Cypress tests for a Storybook story, then check out the [component-cypress-spec generator docs](/nx-api/react/generators/component-cypress-spec)
If you're wanting to create Storybook stories for a component, then check out the [stories generator docs](/nx-api/react/generators/stories) or [component-story generator docs](/nx-api/react/generators/component-cypress-spec)
If you're wanting to create Storybook stories for a component, then check out the [stories generator docs](/nx-api/react/generators/stories)
{% /callout %}