Skip to content

Commit

Permalink
Updated README doc links [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
ambrauer committed Mar 20, 2023
1 parent 00506a1 commit af15a3d
Show file tree
Hide file tree
Showing 22 changed files with 63 additions and 93 deletions.
7 changes: 3 additions & 4 deletions packages/create-sitecore-jss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains initializers / templates for JSS sample applications.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html)
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html)

[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdks--jss-.html)
6 changes: 2 additions & 4 deletions packages/create-sitecore-jss/src/templates/angular/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Sitecore JSS Angular Sample Application

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-angular.html)
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-angular.html)



## App setup
Expand Down
8 changes: 4 additions & 4 deletions packages/create-sitecore-jss/src/templates/nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sitecore JSS Next.js Sample Application

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html).

[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)

[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

Sitecore JSS for SSR using Experience Edge is considered experimental.

<!---
@TODO: Update to version 20.0.0 docs before release
-->

[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/server-side-render-jss-apps-headlessly-using-a-sitecore-experience-edge-endpoint.html)
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/server-side-render-jss-apps-headlessly-using-a-sitecore-experience-edge-endpoint.html)

> This is a sample setup that is not officially supported by Sitecore.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ This is a sample setup showing one one of how you can configure rendering server

The setup is using `sitecore-jss-proxy` that enables request proxying to Sitecore CD along with the http cookies to enable tracking, personalization and contact identification.

<!---
@TODO: Update to version 20.0.0 docs before release
-->

[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/server-side-render-jss-apps-headlessly-using-the-jss-proxy.html)
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/walkthrough--rendering-a-jss-app-server-side-using-the-headless-jss-proxy.html)

> This is a sample setup that is not officially supported by Sitecore.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ server.use(

/**
* Output caching, can be enabled,
* Read about restrictions here: {@link https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/caching-in-headless-server-side-rendering-mode.html}
* Read about restrictions here: {@link https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/caching-in-headless-server-side-rendering-mode.html}
*/
//server.use(cacheMiddleware());

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Sitecore JSS React Native Sample Application

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react-native.html)

[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react-native.html)

## Note

Expand Down
6 changes: 2 additions & 4 deletions packages/create-sitecore-jss/src/templates/react/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Sitecore JSS React Sample Application

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react.html)

[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react.html)

## Disconnected Sitecore-less Development

Expand Down
6 changes: 2 additions & 4 deletions packages/create-sitecore-jss/src/templates/vue/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Sitecore JSS Vue.js Sample Application

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-vue-js.html)

[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-vue-js.html)

## Project setup
```
Expand Down
10 changes: 4 additions & 6 deletions packages/sitecore-jss-angular-schematics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains Angular developer code generation schematics.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Installation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/jss-angular-schematics.html)
[Usage](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/scaffolding-components-in-jss-apps.html)

[API reference documentation](/ref-docs/sitecore-jss-angular-schematics/).
[Installation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/jss-angular-schematics.html)
[Usage](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/scaffolding-components-in-jss-apps.html)

[API reference documentation](/ref-docs/sitecore-jss-angular-schematics/)
8 changes: 3 additions & 5 deletions packages/sitecore-jss-angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains Angular integration components and services for JSS.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-angular.html)

[API reference documentation](/ref-docs/sitecore-jss-angular/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-angular.html)

[API reference documentation](/ref-docs/sitecore-jss-angular/)
3 changes: 2 additions & 1 deletion packages/sitecore-jss-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains the JSS command line interface.

[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk-cli-tools.html)
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk-cli-tools.html)

[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk-cli-tools.html)
6 changes: 4 additions & 2 deletions packages/sitecore-jss-dev-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains developer tooling, such as development proxies and deployment scripts.

Consult the [Sitecore JSS documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html) for further details.
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html)

Consult the package [API reference documentation](/ref-docs/sitecore-jss-dev-tools/).
[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdks--jss-.html)

[API reference documentation](/ref-docs/sitecore-jss-dev-tools/)
8 changes: 3 additions & 5 deletions packages/sitecore-jss-forms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains the APIs for Sitecore Forms integration.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/jss-forms-api.html)

[API reference documentation](/ref-docs/sitecore-jss-forms/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/jss-forms-api.html)

[API reference documentation](/ref-docs/sitecore-jss-forms/)
10 changes: 5 additions & 5 deletions packages/sitecore-jss-nextjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains Next.js components and integration for JSS.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)

[API reference documentation](/ref-docs/sitecore-jss-nextjs/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-next-js.html)

[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdk--jss--for-next-js.html)

[API reference documentation](/ref-docs/sitecore-jss-nextjs/)
8 changes: 3 additions & 5 deletions packages/sitecore-jss-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains the headless-mode SSR proxy implementation.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/server-side-render-jss-apps-headlessly-using-the-jss-proxy.html)

[API reference documentation](/ref-docs/sitecore-jss-proxy/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/server-side-render-jss-apps-headlessly-using-the-jss-proxy.html)

[API reference documentation](/ref-docs/sitecore-jss-proxy/)
12 changes: 5 additions & 7 deletions packages/sitecore-jss-react-forms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@ This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It

> NOTE: This module is intended to be copied from and extended as needed - it is not meant to be a heavyweight forms implementation.
<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Installation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/install-the-jss-forms-for-react-package-in-a-react-or-next-js-jss-app.html)

[Preparing a Sitecore Form for JSS rendering](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/walkthrough--using-a-sitecore-form-in-jss-applications.html)
[Installation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/install-the-jss-forms-for-react-package-in-a-react-or-next-js-jss-app.html)

[Implement a Sitecore Form in a Next.js JSS app](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/implement-a-sitecore-form-in-a-jss-next-js-app.html)
[Preparing a Sitecore Form for JSS rendering](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/walkthrough--using-a-sitecore-form-in-jss-applications.html)

[Implement a Sitecore Form in a React JSS app](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/implement-a-sitecore-form-in-a-jss-react-app.html)
[Implement a Sitecore Form in a Next.js JSS app](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/implement-a-sitecore-form-in-a-jss-next-js-app.html)

[Implement a Sitecore Form in a React JSS app](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/implement-a-sitecore-form-in-a-jss-react-app.html)
8 changes: 3 additions & 5 deletions packages/sitecore-jss-react-native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains the integration for React Native (services & components).

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react-native.html)

[API reference documentation](/ref-docs/sitecore-jss-react-native/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react-native.html)

[API reference documentation](/ref-docs/sitecore-jss-react-native/)
8 changes: 3 additions & 5 deletions packages/sitecore-jss-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains React components and integration for JSS.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react.html)

[API reference documentation](/ref-docs/sitecore-jss-react/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-react.html)

[API reference documentation](/ref-docs/sitecore-jss-react/)
4 changes: 2 additions & 2 deletions packages/sitecore-jss-rendering-host/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains the rendering host implementation.

Consult the [Sitecore JSS documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html) for further details.
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html)

Consult the package [API reference documentation](/ref-docs/sitecore-jss-rendering-host/).
[API reference documentation](/ref-docs/sitecore-jss-rendering-host/)
8 changes: 3 additions & 5 deletions packages/sitecore-jss-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains Vue integration and components for JSS.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-vue-js.html)

[API reference documentation](/ref-docs/sitecore-jss-vue/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdk--jss--for-vue-js.html)

[API reference documentation](/ref-docs/sitecore-jss-vue/)
10 changes: 5 additions & 5 deletions packages/sitecore-jss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains the core JSS APIs (layout service) and utilities.

<!---
@TODO: Update to version 20.0.0 docs before release
-->
[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html)

[API reference documentation](/ref-docs/sitecore-jss/).
[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/sitecore-javascript-rendering-sdks--jss-.html)

[Documentation (XM Cloud)](https://doc.sitecore.com/xmc/en/developers/xm-cloud/sitecore-javascript-rendering-sdks--jss-.html)

[API reference documentation](/ref-docs/sitecore-jss/)

0 comments on commit af15a3d

Please sign in to comment.