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.

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

[Docs] Nav updates for new troubleshooting pages #623

Merged
merged 1 commit into from
Mar 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ To create the `MyProject` solution:

> On local environments, Sitecore instances are installed using privately signed certificates. `.\init.ps1` generates certificates using the `mkcert` utility. Node.js rejects these certificates because their root CAs are not known.
>
> If this is your first time using `mkcert` with Node.js, you will need to [manually set the `NODE_EXTRA_CA_CERTS` environment variable](/docs/temp/node-certificates) to prevent HTTPS errors.
> If this is your first time using `mkcert` with Node.js, you will need to [manually set the `NODE_EXTRA_CA_CERTS` environment variable](/docs/fundamentals/troubleshooting/node-certificates) to prevent HTTPS errors.
>
> The `.\init.ps1` script will instruct you on how to set the `NODE_EXTRA_CA_CERTS` environment variable in your user or system environment variables:
>
Expand Down
2 changes: 1 addition & 1 deletion docs/data/routes/docs/nextjs/troubleshooting/en.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you are working with a local Sitecore instance using a privately signed certi

> UnauthorizedError: invalid signature

Ensure you've [configured Sitecore CA certificates for Node.js](/docs/temp/node-certificates).
Ensure you've [configured Sitecore CA certificates for Node.js](/docs/fundamentals/troubleshooting/node-certificates).

## Errors deploying a JSS app locally

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ It is possible to build a simple login/logout using the [SSC Authentication serv
* The proxy system utilized by Headless mode is able to proxy requests to the SSC Auth services, and proxy the `.ASPXAUTH` cookie.
* Because the requests are proxied, CORS headers should not be an issue.
* For login functionality to work however, the `apiHost` in `config.js` of the sample headless server needs to be updated to SSL, e.g. `https://JssReactWeb`.
* If proxying to a development Sitecore instance using a privately signed certificate, ensure you've [configured Sitecore CA certificates for Node.js](/docs/temp/node-certificates).
* If proxying to a development Sitecore instance using a privately signed certificate, ensure you've [configured Sitecore CA certificates for Node.js](/docs/fundamentals/troubleshooting/node-certificates).
* Alternatively, you can disable SSL validation entirely by setting `secure` to `false` in the proxy options, e.g. in `config.js`

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ All Sitecore marketing features are supported by this headless mode, including p

> NOTE: It is possible to configure these settings using environment variables as well, if that is preferable. This is great for containers and some PaaS hosts.

2. If proxying to a development Sitecore instance using a privately signed certificate, ensure you've [configured Sitecore CA certificates for Node.js](/docs/temp/node-certificates). Alternatively, you can disable SSL validation entirely by setting `secure` to `false` in the proxy options, e.g. in `/config.js`
2. If proxying to a development Sitecore instance using a privately signed certificate, ensure you've [configured Sitecore CA certificates for Node.js](/docs/fundamentals/troubleshooting/node-certificates). Alternatively, you can disable SSL validation entirely by setting `secure` to `false` in the proxy options, e.g. in `/config.js`

```
proxyOptions: {
Expand Down
10 changes: 10 additions & 0 deletions docs/src/app/components/Navigation/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,16 @@ export default {
},
],
},
{
url: 'troubleshooting',
displayName: 'Troubleshooting',
children: [
{
url: 'node-certificates',
displayName: 'Sitecore CA certificates for Node.js',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "CA certificate" a commonly known term? Personally, I had to look this up to make sure it's referring to what I thought it was referring to, as I'm used to hearing "secure/ssl/https/self-signed certificates"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, maybe we should drop "CA"? Just worried about making the name too broad / generic since this article is all about the "NODE_EXTRA_CA_CERTS". More than likely they'll land here from one of the cross-links or searching for the specific errors.

},
],
},
],
},
{
Expand Down
4 changes: 4 additions & 0 deletions docs/src/app/components/Navigation/nextjs.js
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,10 @@ export default {
},
],
},
{
url: 'troubleshooting',
displayName: 'Troubleshooting',
},
],
links: [],
};