Skip to content

Commit

Permalink
docs: update developers website url (#2495)
Browse files Browse the repository at this point in the history
  • Loading branch information
yfodil authored Apr 2, 2024
1 parent c6474c2 commit 3358ca3
Show file tree
Hide file tree
Showing 61 changed files with 79 additions and 78 deletions.
2 changes: 1 addition & 1 deletion .github/contributing/pull_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Below are some common items that will get flagged during documentation reviews:

- [ ] __Reasoning for Change__: Documentation updates should include an explanation for why the update is needed.
- [ ] __Prefer Scaleway Documentation__: Documentation about Scaleway service features and valid argument values that are likely to update over time should link to Scaleway service user guides and API references where possible.
You can find all those document at <https://developers.scaleway.com>
You can find all those document at <https://www.scaleway.com/en/developers>
- [ ] __Terraform Configuration Language Features__: Individual resource documentation pages and examples should refrain from highlighting particular Terraform configuration language syntax workarounds or features such as `variable`, `local`, `count`, and built-in functions.

### Enhancement/Bugfix to a Resource
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/baremetal_os.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_baremetal_os"
# scaleway_baremetal_os

Gets information about a baremetal operating system.
For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/elastic-metal/#path-os-list-available-oses).

You can also use the [scaleway-cli](https://github.com/scaleway/scaleway-cli) with `scw baremetal os list` to list all available operating systems.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/regions_and_zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ If you need to retrieve the raw ID of the resource, you can either :

---

More information regarding zones and regions can be found [here](https://developers.scaleway.com/en/quickstart/#region-and-zone).
More information regarding zones and regions can be found [here](https://www.scaleway.com/en/developers/api/#regions-and-zones).
2 changes: 1 addition & 1 deletion docs/guides/using-vpc-bastion-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ This is used to resolve your Instance on a Private Network.

In order to resolve the Instances using your Bastion you should set the `dns_local_name` with `scaleway_vpc_private_network.pn.name`.

Please check our API [documentation](https://developers.scaleway.com/en/products/vpc-gw/api/v1/#dns-local-name-5b691b) for more details.
Please check our API [documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-dhcp-create-a-dhcp-configuration) for more details.

```hcl
resource scaleway_vpc_public_gateway_dhcp "dhcp" {
Expand Down
1 change: 1 addition & 0 deletions docs/resources/account_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ page_title: "Scaleway: scaleway_account_project"
# Resource: scaleway_account_project

Manages organization's projects on Scaleway.
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/account/project-api/).

## Example Usage

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/baremetal_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_baremetal_server"

# Resource: scaleway_baremetal_server

Creates and manages Scaleway Compute Baremetal servers. For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).
Creates and manages Scaleway Compute Baremetal servers. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/elastic-metal).

## Example Usage

Expand Down Expand Up @@ -131,12 +131,12 @@ resource "scaleway_baremetal_server" "base" {
The following arguments are supported:

- `offer` - (Required) The offer name or UUID of the baremetal server.
Use [this endpoint](https://developers.scaleway.com/en/products/baremetal/api/#get-334154) to find the right offer.
Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#get-334154) to find the right offer.

~> **Important:** Updates to `offer` will recreate the server.

- `os` - (Required) The UUID of the os to install on the server.
Use [this endpoint](https://developers.scaleway.com/en/products/baremetal/api/#get-87598a) to find the right OS ID.
Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#get-87598a) to find the right OS ID.
~> **Important:** Updates to `os` will reinstall the server.
- `ssh_key_ids` - (Required) List of SSH keys allowed to connect to the server.
- `user` - (Optional) User used for the installation.
Expand All @@ -152,7 +152,7 @@ The following arguments are supported:
- `tags` - (Optional) The tags associated with the server.
- `options` - (Optional) The options to enable on the server.
~> The `options` block supports:
- `id` - (Required) The id of the option to enable. Use [this endpoint](https://developers.scaleway.com/en/products/baremetal/api/#get-012dcc) to find the available options IDs.
- `id` - (Required) The id of the option to enable. Use [this endpoint](https://www.scaleway.com/en/developers/api/elastic-metal/#get-012dcc) to find the available options IDs.
- `expires_at` - (Optional) The auto expiration date for compatible options
- `private_network` - (Required) The private networks to attach to the server. For more information, see [the documentation](https://www.scaleway.com/en/docs/compute/elastic-metal/how-to/use-private-networks/)
- `id` - (Required) The id of the private network to attach.
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@ The following arguments are optional:

- `timeout` - (Optional) The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

- `privacy` - (Optional) The privacy type define the way to authenticate to your container. Please check our dedicated [section](https://developers.scaleway.com/en/products/containers/api/#protocol-9dd4c8).
- `privacy` - (Optional) The privacy type define the way to authenticate to your container. Please check our dedicated [section](https://www.scaleway.com/en/developers/api/serverless-containers/#protocol-9dd4c8).

- `registry_image` - (Optional) The registry image address. e.g: **"rg.fr-par.scw.cloud/$NAMESPACE/$IMAGE"**.

- `registry_sha256` - (Optional) The sha256 of your source registry image, changing it will re-apply the deployment. Can be any string.

- `max_concurrency` - (Optional) The maximum number of simultaneous requests your container can handle at the same time. Defaults to 50.

- `protocol` - (Optional) The communication [protocol](https://developers.scaleway.com/en/products/containers/api/#protocol-9dd4c8) http1 or h2c. Defaults to http1.
- `protocol` - (Optional) The communication [protocol](https://www.scaleway.com/en/developers/api/serverless-containers/#protocol-9dd4c8) http1 or h2c. Defaults to http1.

- `port` - (Optional) The port to expose the container. Defaults to 8080.

Expand Down Expand Up @@ -126,7 +126,7 @@ The supported protocols are:
By default, creating a container will make it `public`, meaning that anybody knowing the endpoint could execute it.
A container can be made `private` with the privacy parameter.

Please check our [authentication](https://developers.scaleway.com/en/products/containers/api/#protocol-9dd4c8) section
Please check our [authentication](https://www.scaleway.com/en/developers/api/serverless-containers/#protocol-9dd4c8) section

## Memory and vCPUs configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/container_cron.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ check [containers-limitations](https://www.scaleway.com/en/docs/compute/containe
.

You can check also
our [containers cron api documentation](https://developers.scaleway.com/en/products/containers/api/#crons-942bf4).
our [containers cron api documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#crons-942bf4).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/container_namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_container_namespace"
# Resource: scaleway_container_namespace

Creates and manages Scaleway Serverless Container Namespace.
For more information see [the documentation](https://developers.scaleway.com/en/products/containers/api/#namespaces-cdce79).
For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#namespaces-cdce79).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/container_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_container_token"
# Resource: scaleway_container_token

Creates and manages Scaleway Container Token.
For more information see [the documentation](https://developers.scaleway.com/en/products/containers/api/#tokens-26b085).
For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#tokens-26b085).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/flexible_ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_flexible_ip"
# Resource: scaleway_flexible_ip

Creates and manages Scaleway flexible IPs.
For more information, see [the documentation](https://developers.scaleway.com/en/products/flexible-ip/api).
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/elastic-metal-flexible-ip).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/flexible_ip_mac_address.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_flexible_ip_mac_address"
# Resource: scaleway_flexible_ip_mac_address

Creates and manages Scaleway Flexible IP Mac Addresses.
For more information, see [the documentation](https://developers.scaleway.com/en/products/flexible-ip/api).
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/elastic-metal-flexible-ip/).

## Example Usage

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_function"
# Resource: scaleway_function

Creates and manages Scaleway Functions.
For more information see [the documentation](https://developers.scaleway.com/en/products/functions/api/).
For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-functions).

## Example Usage

Expand Down Expand Up @@ -62,17 +62,17 @@ The following arguments are supported:

- `secret_environment_variables` - (Optional) The [secret environment](https://www.scaleway.com/en/docs/compute/functions/concepts/#secrets) variables of the function.

- `privacy` - Privacy of the function. Can be either `private` or `public`. Read more on [authentication](https://developers.scaleway.com/en/products/functions/api/#authentication)
- `privacy` - Privacy of the function. Can be either `private` or `public`. Read more on [authentication](https://www.scaleway.com/en/developers/api/serverless-functions/#authentication)

- `runtime` - Runtime of the function. Runtimes can be fetched using [specific route](https://developers.scaleway.com/en/products/functions/api/#get-f7de6a)
- `runtime` - Runtime of the function. Runtimes can be fetched using [specific route](https://www.scaleway.com/en/developers/api/serverless-functions/#get-f7de6a

- `min_scale` - Minimum replicas for your function, defaults to 0, Note that a function is billed when it gets executed, and using a min_scale greater than 0 will cause your function container to run constantly.

- `max_scale` - Maximum replicas for your function (defaults to 20), our system will scale your functions automatically based on incoming workload, but will never scale the number of replicas above the configured max_scale.

- `memory_limit` - Memory limit in MB for your function, defaults to 128MB

- `handler` - Handler of the function. Depends on the runtime ([function guide](https://developers.scaleway.com/en/products/functions/api/#create-a-function))
- `handler` - Handler of the function. Depends on the runtime ([function guide](https://www.scaleway.com/en/developers/api/serverless-functions/#create-a-function))

- `timeout` - Holds the max duration (in seconds) the function is allowed for responding to a request

Expand All @@ -98,7 +98,7 @@ In addition to all arguments above, the following attributes are exported:
- `namespace_id` - The namespace ID the function is associated with.
- `domain_name` - The native domain name of the function
- `organization_id` - The organization ID the function is associated with.
- `cpu_limit` - The CPU limit in mCPU for your function. More infos on resources [here](https://developers.scaleway.com/en/products/functions/api/#functions)
- `cpu_limit` - The CPU limit in mCPU for your function. More infos on resources [here](https://www.scaleway.com/en/developers/api/serverless-functions/#functions)

## Import

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/function_cron.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For more details about the limitation
check [functions-limitations](https://www.scaleway.com/en/docs/compute/functions/reference-content/functions-limitations/).

You can check also
our [functions cron api documentation](https://developers.scaleway.com/en/products/functions/api/#crons-942bf4).
our [functions cron api documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#crons-942bf4).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/function_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_function_domain"
# Resource: scaleway_function_domain

Creates and manages Scaleway Function Domain bindings.
For more information see [the documentation](https://developers.scaleway.com/en/products/functions/api/).
For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-functions).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/function_namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_function_namespace"
# Resource: scaleway_function_namespace

Creates and manages Scaleway Function Namespace.
For more information see [the documentation](https://developers.scaleway.com/en/products/functions/api/).
For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-functions/).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/function_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_function_token"
# Resource: scaleway_function_token

Creates and manages Scaleway Function Token.
For more information see [the documentation](https://developers.scaleway.com/en/products/functions/api/#tokens-26b085).
For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#tokens-26b085).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_iam_api_key"
# Resource: scaleway_iam_api_key

Creates and manages Scaleway IAM API Keys. For more information, please
check [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#api-keys-3665ae)
check [the documentation](https://www.scaleway.com/en/developers/api/iam/#api-keys-3665ae)

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_iam_application"

# Resource: scaleway_iam_application

Creates and manages Scaleway IAM Applications. For more information, see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#applications-83ce5e).
Creates and manages Scaleway IAM Applications. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/iam/#applications-83ce5e).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_iam_group"
# Resource: scaleway_iam_group

Creates and manages Scaleway IAM Groups.
For more information, see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#groups-f592eb).
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/iam/#groups-f592eb).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_group_membership.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_iam_group_membership"
# Resource: scaleway_iam_group_membership

Add members to an IAM group.
For more information, see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#groups-f592eb).
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/iam/#groups-f592eb).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_iam_policy"

# Resource: scaleway_iam_policy

Creates and manages Scaleway IAM Policies. For more information, see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#policies-54b8a7).
Creates and manages Scaleway IAM Policies. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/iam/#policies-54b8a7).

~> You can find a detailed list of all permission sets available at Scaleway in the permission sets [reference page](https://www.scaleway.com/en/docs/identity-and-access-management/iam/reference-content/permission-sets/).

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/iam_ssh_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ page_title: "Scaleway: scaleway_iam_ssh_key"

Creates and manages Scaleway IAM SSH Keys.
For more information,
see [the documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#ssh-keys-d8ccd4).
see [the documentation](https://www.scaleway.com/en/developers/api/iam/#ssh-keys-d8ccd4).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/instance_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_instance_image"
# Resource: scaleway_instance_image

Creates and manages Scaleway Compute Images.
For more information, see [the documentation](https://developers.scaleway.com/en/products/instance/api/#images-41389b).
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/instance/#images-41389b).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/instance_ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_instance_ip"

# Resource: scaleway_instance_ip

Creates and manages Scaleway Compute Instance IPs. For more information, see [the documentation](https://developers.scaleway.com/en/products/instance/api/#ips-268151).
Creates and manages Scaleway Compute Instance IPs. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/instance/#ips-268151).

## Example Usage

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/instance_placement_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_instance_placement_group"

# Resource: scaleway_instance_placement_group

Creates and manages Compute Instance Placement Groups. For more information, see [the documentation](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653).
Creates and manages Compute Instance Placement Groups. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/instance/#placement-groups-d8f653).

## Example Usage

Expand All @@ -18,8 +18,8 @@ resource "scaleway_instance_placement_group" "availability_group" {}
The following arguments are supported:

- `name` - (Optional) The name of the placement group.
- `policy_type` - (Defaults to `max_availability`) The [policy type](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653) of the placement group. Possible values are: `low_latency` or `max_availability`.
- `policy_mode` - (Defaults to `optional`) The [policy mode](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653) of the placement group. Possible values are: `optional` or `enforced`.
- `policy_type` - (Defaults to `max_availability`) The [policy type](https://www.scaleway.com/en/developers/api/instance/#placement-groups-d8f653) of the placement group. Possible values are: `low_latency` or `max_availability`.
- `policy_mode` - (Defaults to `optional`) The [policy mode](https://www.scaleway.com/en/developers/api/instance/#placement-groups-d8f653) of the placement group. Possible values are: `optional` or `enforced`.
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the placement group should be created.
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the placement group is associated with.
- `tags` - (Optional) A list of tags to apply to the placement group.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/instance_private_nic.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_instance_private_nic"
# Resource: scaleway_instance_private_nic

Creates and manages Scaleway Instance Private NICs. For more information, see
[the documentation](https://developers.scaleway.com/en/products/instance/api/#private-nics-a42eea).
[the documentation](https://www.scaleway.com/en/developers/api/instance/#private-nics-a42eea).

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/instance_security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page_title: "Scaleway: scaleway_instance_security_group"

# Resource: scaleway_instance_security_group

Creates and manages Scaleway Compute Instance security groups. For more information, see [the documentation](https://developers.scaleway.com/en/products/instance/api/#security-groups-8d7f89).
Creates and manages Scaleway Compute Instance security groups. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/instance/#security-groups-8d7f89).

## Example Usage

Expand Down
Loading

0 comments on commit 3358ca3

Please sign in to comment.