chore: update content (#12714)

* chore: update docs content
This commit is contained in:
Walid Elnozahy 2024-07-30 20:11:59 +03:00 committed by GitHub
parent 1bf12bbdd8
commit 2ed271e76d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 17 additions and 20 deletions

View File

@ -19,7 +19,7 @@ The framework validates service configuration with the help of [AJV](https://ajv
If you were presented with configuration error (or a warning, depending on `configValidationMode` setting) it could mean that:
- Service configuration is invalid and you need to correct an issue related to your serverless.yml
- Configuration related to external plugin does not have an associated JSON Schema. In such cases, please report the issue with the plugin author and provide them the details on how to [extend validation schema](/framework/docs/providers/aws/guide/plugins/) in order to permanently correct the issue.
- Configuration related to external plugin does not have an associated JSON Schema. In such cases, please report the issue with the plugin author and provide them the details on how to extend validation schema in order to permanently correct the issue.
- However unlikely, there may be a bug (or missing) schema configuration for the framework. If you believe this to be the case please report at [https://github.com/serverless/serverless/issues/new](https://github.com/serverless/serverless/issues/new?template=bug_report.md)
**Note**: In a warning mode (with `configValidationMode: warn` set in configuration) Framework commands are not blocked in any way, e.g. `sls deploy` will still attempt to deploy the service normally (still depending on the source of the warning, success of a deployment may vary)

View File

@ -229,8 +229,8 @@ In these cases, you must run all commands from the root: `serverless service-a:d
The following variables are supported in `serverless-compose.yml`:
- [`${sls:stage}`](/framework/docs/guides/variables.md#referencing-serverless-core-variables)
- [`${env:xxx}`](/framework/docs/guides/variables.md#referencing-environment-variables)
- [`${sls:stage}`](./variables/env-vars.md#referencing-serverless-core-variables)
- [`${env:xxx}`](./variables/env-vars.md#referencing-environment-variables)
### Differences with `serverless.yml`

View File

@ -39,7 +39,7 @@ Before you setup your CI/CD workflow, make sure you meet the following requireme
As is the case with deployments from the Serverless Framework CLI, Serverless CI/CD requires access to your AWS Account in order to deploy your services. To make this process as secure as possible, Serverless CI/CD will generate short-lived credentials to your AWS account on each deployment. This is done by creating an AWS Access Role in your AWS account and associating it with a Provider in the Serverless Framework Dashboard.
If youve already set up an AWS Access Role with a Provider, you can skip this step. Otherwise, please go through the instructions on our [Provider documentation page](../providers.md) to help set one up.
If youve already set up an AWS Access Role with a Provider, you can skip this step. Otherwise, please go through the instructions on our [Provider documentation page](../../dashboard/providers.md) to help set one up.
### Step 2: Connect to Github

View File

@ -112,8 +112,8 @@ In addition to the out-of-the-box instrumentation provided by Serverless Framewo
See the SDK documentation for Node and Python for details:
- [Full NodeJS Documentation](../sdk/nodejs.md)
- [Full Python Documentation](../sdk/python.md)
- [Full NodeJS Documentation](./sdk/nodejs.md)
- [Full Python Documentation](./sdk/python.md)
## Supported AWS Lambda Runtimes
@ -182,7 +182,7 @@ stages:
observability: false
```
Please note, if you have an Observability Integration already established with one or multiple AWS accounts, you will have to delete those via the [Serverless Framework Dashboard)[https://app.serverless.com]
Please note, if you have an Observability Integration already established with one or multiple AWS accounts, you will have to delete those via the [Serverless Framework Dashboard](https://app.serverless.com)
### Disabling Trace Sampling

View File

@ -23,8 +23,7 @@ keywords:
Metrics is a Serverless Dashboard feature which enables viewing metrics across
AWS Accounts and Lambda functions.
To get started you need to [add an AWS Account integration](./integrations/aws.md)
and [enable Dev or Prod Instrumentation Mode](./instrumentation.md).
To get started you need to [add an AWS Account integration](./README.md).
Once instrumentation is enabled, go to the **Metrics** page to view all of your
AWS Lambda function metrics including durations, invocations, and event counts.

View File

@ -25,9 +25,9 @@ When using the Serverless Framework Dashboard, the Framework automatically injec
It also has certain features you can use directly in your lambda such as capturing an error in the Dashboard without causing your lambda to error and custom function spans.
[NodeJS Documentation](../sdk/nodejs.md)
[NodeJS Documentation](./nodejs.md)
[Python Documentation](../sdk/python.md)
[Python Documentation](./python.md)
## Advanced Span Configuration

View File

@ -95,7 +95,7 @@ with [`--keep-names`](https://esbuild.github.io/api/#keep-names) option.
### Enable Instrumentation
The SDK will merely generate the necessary Tags, Spans, and Events; however,
you must [Enable Instrumentation](/framework/docs/guide/monitoring/instrumentation)
you must [Enable Instrumentation](../README.md#set-up-via-serverless-framework-dashboard-ui)
for each of your functions for Serverless Dashboard to ingest the data.
## Usage
@ -124,8 +124,7 @@ package, and configure Node to use them with captured Errors in the Serverless
SDK.
If you are on a version of the Serverless Framework prior to 3.36.0, you will
need to remove the Dashboard SDK Wrapper by setting `disableWrapping`. More
details about wrapping are in the [Upgrade to V2 guide](https://www.serverless.com/framework/docs/guides/dashboard/upgrade-to-v2#remove-dashboard-sdk-wrapping-optional).
need to remove the Dashboard SDK Wrapper by setting `disableWrapping`.
```yaml
custom:

View File

@ -50,7 +50,7 @@ pip install serverless-sdk
### Enable Instrumentation
The SDK will merely generate the necessary Tags, Spans, and Events; however,
you must [Enable Instrumentation](/framework/docs/monitoring) for each of
you must [Enable Instrumentation](../README.md#set-up-via-serverless-framework-dashboard-ui) for each of
your functions for Serverless Framework Dashboard to ingest the data.
## Usage

View File

@ -23,7 +23,7 @@ keywords:
# Traces
Traces, Spans, Logs, and Events are captured and made available in Trace
Explorer for your AWS Lambda functions when [Instrumentation](./instrumentation.md)
Explorer for your AWS Lambda functions when [Instrumentation](./README.md#set-up-via-serverless-framework-dashboard-ui)
is enabled.
Serverless Dashboard provides a set of tools to analyzing Traces.

View File

@ -93,7 +93,7 @@ functions:
customProperty: foobar # <-- use defineFunctionEventProperties
```
We'll walk though those helpers. You may also want to check out examples from [helpers tests](tests/fixtures/configSchemaExtensions/test-plugin.js)
We'll walk though those helpers. You may also want to check out examples from [helpers tests](../../../test/fixtures/programmatic/config-schema-extensions/test-plugin.js)
### Top-level properties via `defineTopLevelProperty`

View File

@ -98,7 +98,7 @@ provider:
APP_DOMAIN: ${param:domain}
```
Read all about parameters in the [Parameters documentation](../../guides//parameters.md).
Read all about parameters in the [Parameters documentation](../../guides/parameters.md).
## Multiple Configuration Files

View File

@ -32,8 +32,7 @@ Upon deployment, the framework will deploy any infrastructure required for an ev
Infrastructure which is created to support events in the `events` list may be
referenced using CloudFormation intrinsic functions like `Fn::GetAtt` or
`Fn::Ref` (or their shorthand counterparts). For details on referencing created
resources in AWS, see the [AWS CloudFormation Resource
Reference](./resources.md#aws-cloudformation-resource-reference) section on the
resources in AWS, see the [AWS CloudFormation Resource Reference](./resources.md#aws-cloudformation-resource-reference) section on the
[AWS - Resources](./resources.md) page.
## Configuration