[PFX-507] Add DocSearch to Gasket Site (#984)

godaddy · Dec 11, 2024 · 21c240e · 21c240e
1 parent a8db9a0
commit 21c240e
Show file tree

Hide file tree

Showing 58 changed files with 954 additions and 693 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/authoring-presets.md b/docs/authoring-presets.md
@@ -186,5 +186,5 @@ You can also add configuration to the `context` object through the command line
 npx create-gasket-app <app-name> --presets <@your/gasket-preset-example> --config "{\"my\": \"value\"}"
 ```
 
-[recommended naming conventions]: /docs/plugins.md#recommended-naming-convention
-[plugin]: /docs/plugins.md
+[recommended naming conventions]: /docs/authoring-plugins.md#recommended-naming-convention
+[plugin]: /docs/authoring-plugins.md
diff --git a/docs/generated-docs/lifecycle-graphs.md b/docs/generated-docs/lifecycle-graphs.md
@@ -1,7 +1,8 @@
 ```mermaid
 graph LR;
 middleware -- exec --> apmTransaction;
-ready -- execSync --> commands;
+commands -- exec --> build;
+ready -- exec --> commands;
 express -- execWaterfall --> composeServiceWorker;
 init -- execSync --> createLogger;
 start -- execWaterfall --> createServers;
@@ -14,6 +15,7 @@ createServers -- exec --> errorMiddleware;
 createServers -- exec --> express;
 createServers -- exec --> fastify;
 gasket/plugin-data -- execWaterfall --> gasketData;
+gasket/plugin-https-proxy -- execWaterfall --> httpsProxy;
 middleware -- execWaterfall --> initReduxState;
 middleware -- exec --> initReduxStore;
 build-cmd(build) --> initWebpack;

diff --git a/docs/package-management.md b/docs/package-management.md
@@ -69,4 +69,4 @@ dependency definitions.
 
 [npm install]: https://docs.npmjs.com/cli/install
 [yarn install]: https://yarnpkg.com/en/docs/cli/add#toc-yarn-add-dev-d
-[one-off plugin]: plugins.md#one-off-plugins
+[one-off plugin]: authoring-plugins.md#one-off-plugins
diff --git a/docs/upgrade-to-6.md b/docs/upgrade-to-6.md
@@ -54,7 +54,7 @@ There are two ways to add data to the Gasket Data object:
 We have created the `public` property in the `app.config.js` file to allow the
 client to access app config properties.
 
-The [@gasket/plugin-config] plugin will return these `public` config properties
+The @gasket/plugin-config plugin will return these `public` config properties
 to the browser. The [@gasket/data] package will then access the properties and
 make them available on `.config`.
 
@@ -373,7 +373,7 @@ to avoid unnecessarily committing those files to the git repo.
 ### Lifecycle name
 
 If you have a custom lifecycle hook to determine the locale, either in a plugin
-or [lifecycle file], then you will need to update the name and the signature.
+or lifecycle file, then you will need to update the name and the signature.
 
 ```diff
 // gasket-plugin-example.js
@@ -660,17 +660,14 @@ _Impacted Plugins/Packages: `@gasket/resolve`, `@gasket/engine`_
 
 <!-- LINKS -->
 
-[intl]: #intl
-[app config]: #public-config-property
 [next.js routing documentation]: https://nextjs.org/docs/routing/introduction
 [webpack website]: https://webpack.js.org/configuration/node/
 [gasket data script tag]: /packages/gasket-data/README.md#usage
 [new utility HOC]: #inject-gasket-data
-[@gasket/plugin-config]: /packages/gasket-plugin-response-data/README.md
 [@gasket/data]: /packages/gasket-data/README.md
 [@gasket/plugin-workbox]: /packages/gasket-data/README.md
 [@gasket/plugin-service-worker]: /packages/gasket-data/README.md
-[naming convention]: /packages/gasket-resolve/README.md#plugins
+[naming convention]: /docs/authoring-plugins.md#recommended-naming-convention
 
 <!-- LINKS -->
 
@@ -684,7 +681,6 @@ _Impacted Plugins/Packages: `@gasket/resolve`, `@gasket/engine`_
 [select locale message example]: /packages/gasket-plugin-intl/README.md#selectlocalemessage
 [@gasket/react-intl]: /packages/gasket-react-intl/README.md
 [@gasket/plugin-nextjs]: /packages/gasket-plugin-nextjs/README.md
-[lifecycle file]: /packages/gasket-plugin-lifecycle/README.md#usage
 [@gasket/plugin-redux]: /packages/gasket-plugin-redux/README.md
 [Redux configuration]: /packages/gasket-plugin-redux/README.md#configuration
 [@gasket/plugin-webpack]: /packages/gasket-plugin-webpack/README.md
@@ -697,4 +693,3 @@ _Impacted Plugins/Packages: `@gasket/resolve`, `@gasket/engine`_
 [resolve.fallback]: https://webpack.js.org/configuration/resolve/#resolvefallback
 [Webpack 5 docs]: https://webpack.js.org/configuration/node/
 [@godaddy/eslint-plugin-react-intl]: https://github.com/godaddy/eslint-plugin-react-intl
-