Skip to content

Commit f1eebae

Browse files
committed
Integrate README updates
1 parent 55d3619 commit f1eebae

File tree

7 files changed

+56
-32
lines changed

7 files changed

+56
-32
lines changed

README.md

+19-28
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,6 @@ If you are using [Scaleway IAM](/identity-and-access-management/iam/how-to/activ
4444

4545
## Contents
4646

47-
Serverless Framework handles everything from creating namespaces to function/code deployment by calling API endpoints under the hood.
48-
4947
- [Quickstart](#quickstart)
5048
- [Configuration](#configuration)
5149
- [Supported commands](#supported-commands)
@@ -215,18 +213,19 @@ custom:
215213
216214
## Auto-deletion
217215
218-
By default, the `serverless deploy` command applies the configuration located in your `serverless.yml` and removes functions in that namespace that are not in the file.
216+
By default, `serverless deploy` applies the configuration located in your `serverless.yml` and removes functions in that namespace that are not in the file.
219217

220218
This can be switched off by setting the `singleSource` option to `false`.
221219

222220
### Local testing
223221

224222
`serverless invoke local` is **not supported** directly but instead we provide additional packages to install close to your handler.
225223

226-
Documentation is available through runtimes frameworks for :
227-
* [Go](https://github.com/scaleway/serverless-functions-go)
228-
* [Python](https://github.com/scaleway/serverless-functions-python)
229-
* [Node](https://github.com/scaleway/serverless-functions-node)
224+
Documentation is available through runtimes frameworks for:
225+
226+
- [Go](https://github.com/scaleway/serverless-functions-go)
227+
- [Python](https://github.com/scaleway/serverless-functions-python)
228+
- [Node](https://github.com/scaleway/serverless-functions-node)
230229

231230
## Logs
232231

@@ -244,39 +243,31 @@ The `serverless info` command gives you information about your functions' or con
244243

245244
## Documentation and useful links
246245

247-
- [Official Scaleway Serverless Functions Documentation](https://www.scaleway.com/en/docs/compute/functions/api-cli/fun-uploading-with-serverless-framework/)
248-
- [Official Scaleway Serverless Containers Documentation](https://www.scaleway.com/en/docs/compute/containers/api-cli/cont-uploading-with-serverless-framework/)
246+
- [Scaleway Serverless Functions Documentation](https://www.scaleway.com/en/docs/compute/functions/api-cli/fun-uploading-with-serverless-framework/)
247+
- [Scaleway Serverless Containers Documentation](https://www.scaleway.com/en/docs/compute/containers/api-cli/cont-uploading-with-serverless-framework/)
249248
- [Serverless Framework documentation](https://serverless.com)
250-
- [Scaleway Cloud Provider](https://scaleway.com)
251-
- [Scaleway Serverless sample projects](https://github.com/scaleway/serverless-examples)
252-
253-
## Troubleshooting
254-
255-
### Rate Limiting Issue
256-
257-
If you are experiencing rate limiting issues (error 429) in your application, consider engaging with the support and/or the community. When seeking assistance, remember to provide relevant details, such as the specific rate limiting error messages, the affected components, and any relevant configuration information. This will enable us to better understand your situation and provide appropriate guidance or solutions.
249+
- [Scaleway Serverless example projects](https://github.com/scaleway/serverless-examples)
258250

259251
## Contributing
260252

261253
This plugin is developed and maintained by the `Scaleway Serverless Team`, but we welcome pull requests and issues, and are available to chat on our [Community Slack Channels](https://scaleway-community.slack.com/): #serverless-containers and #serverless-functions.
262254

255+
If you are looking for a way to contribute please read [CONTRIBUTING.md](./.github/CONTRIBUTING.md).
256+
263257
For general information about developing Serverless Framework, refer to the Serverless Framework [plugins documentation](https://www.serverless.com/framework/docs/guides/plugins/creating-plugins).
264258

265-
To run Serverless Framework with a local checkout of this plugin, you can modify the `serverless.yml` for one or more functions as follows:
259+
## Help & support
266260

267-
```yaml
268-
...
261+
- Scaleway support is available on Scaleway Console.
262+
- Additionally, you can join our [Slack Community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/)
269263

270-
# Change this
271-
plugins:
272-
- serverless-scaleway-functions
264+
## Reach Us
273265

274-
# To this
275-
plugins:
276-
- <path to checkout of this project>
277-
```
266+
We love feedback. Feel free to:
278267

279-
Then you can run commands as normal.
268+
- Open a [Github issue](https://github.com/scaleway/serverless-scaleway-functions/issues/new)
269+
- Send us a message on the [Scaleway Slack community](https://slack.scaleway.com/), in the
270+
[#serverless-functions](https://scaleway-community.slack.com/app_redirect?channel=serverless-functions) channel.
280271

281272
## License
282273

docs/development.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Development
2+
3+
To run Serverless Framework with a local checkout of this plugin, you can modify the `serverless.yml` for one or more functions as follows:
4+
5+
```yaml
6+
...
7+
8+
# Change this
9+
plugins:
10+
- serverless-scaleway-functions
11+
12+
# To this
13+
plugins:
14+
- <path to checkout of this project>
15+
```
16+
17+
Then you can run commands as normal.

docs/es-modules.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Path to your handler file (from `serverless.yml`), omit `./`, `../`, and add the
99
- secondHandler.js => module.exports.mySecondHandler = ...
1010
- serverless.yml
1111
```
12+
1213
In serverless.yml:
14+
1315
```yml
1416
provider:
1517
# ...
@@ -42,12 +44,12 @@ According to the official documentation, to use ES modules you can specify the m
4244
This then enables you to write your code for ES modules:
4345

4446
```javascript
45-
export {handle};
47+
export { handle };
4648
4749
function handle (event, context, cb) {
4850
return {
4951
body: process.version,
50-
headers: {"Content-Type": ["text/plain"]},
52+
headers: { "Content-Type": ["text/plain"] },
5153
statusCode: 200,
5254
};
5355
};
@@ -56,6 +58,7 @@ function handle (event, context, cb) {
5658
The use of ES modules is encouraged since they are more efficient and make setup and debugging much easier.
5759

5860
Note that using `"type": "module"` or `"type": "commonjs"` in your `package.json` file will enable or disable some features in Node runtime, such as:
61+
5962
- `commonjs` is used as the default value
6063
- `commonjs` allows you to use `require/module.exports` (synchronous code loading - it basically copies all file contents)
6164
- `module` allows you to use `import/export` ES6 instructions (asynchronous loading - more optimized as it imports only the pieces of code you need)

docs/events.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ functions:
1919
# "events" is a list of triggers, the first key being the type of trigger.
2020
- schedule:
2121
# CRON Job Schedule (UNIX Format)
22-
rate: '1 * * * *'
22+
rate: "1 * * * *"
23+
2324
# Input variable are passed in your function's event during execution
2425
input:
2526
key: value
@@ -33,10 +34,11 @@ custom:
3334
containers:
3435
mycontainer:
3536
directory: my-directory
37+
3638
# Events key
3739
events:
3840
- schedule:
39-
rate: '1 * * * *'
41+
rate: "1 * * * *"
4042
input:
4143
key: value
4244
key2: value2

docs/golang.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Golang
22

33
Path to your handler's **package**. For example, if you have the following structure:
4+
45
```yml
56
- src
67
- testing
@@ -10,7 +11,9 @@ Path to your handler's **package**. For example, if you have the following struc
1011
- serverless.yml
1112
- handler.go -> package main at the root of project
1213
```
14+
1315
Your serverless.yml `functions` should look something like this:
16+
1417
```yml
1518
provider:
1619
# ...

docs/python.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Path to handler file `src/testing/handler.py`:
99
- secondHandler.py => def my_second_handler
1010
- serverless.yml
1111
```
12+
1213
In serverless.yml:
14+
1315
```yml
1416
provider:
1517
# ...

docs/troubleshooting.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Troubleshooting
2+
3+
### Rate Limiting Issue
4+
5+
If you are experiencing rate limiting issues (error 429) in your application, consider engaging with the support and/or the community. When seeking assistance, remember to provide relevant details, such as the specific rate limiting error messages, the affected components, and any relevant configuration information. This will enable us to better understand your situation and provide appropriate guidance or solutions.
6+

0 commit comments

Comments
 (0)