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.

Sign up for GitHub

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

fixing spelling in quickstart and marketplace #476

Merged
merged 2 commits into from
Dec 20, 2024
Merged

fixing spelling in quickstart and marketplace #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4d3a11
fixing spelling in quickstart and marketplace
cnivolle Dec 17, 2024
baa7c6f
Merge branch 'main' into spelling-quickstart-marketplace
cnivolle Dec 20, 2024
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
43 changes: 11 additions & 32 deletions content/doc/marketplace/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,26 +48,17 @@
}
```

Fields
### Available fields

* `id` - An ID for your add-on. All lower case, no spaces or punctuation. Underscores and dashes are allowed. This can’t be changed after the first push. It is also used for HTTP basic auth when making provisioning calls.

* `name` (Optional) - A human-readable name for your add-on. You will be able to change it later in the dashboard, so you don't even have to provide it right now.

* `api/config_vars` - A list of configuration variables that will be returned on provisioning calls. Each `config_var` name must start with the capitalized, add-on id with underscores, as in the example.

* `api/password` - Password that Clever Cloud will send in HTTP basic auth when making provisioning calls. You should generate a long random string for that field.

* `api/sso_salt` - Shared secret used in single sign-on between the Clever Cloud admin panel and your service’s admin panel. You should generate a long random string for that field.

* `api/regions` - The list of geographical zones supported by your add-on. It cannot be empty. As for now, it *MUST* contain the element "eu". More will be supported.

* `api/production/base_url` - The production endpoint on which Clever Cloud sends actions requests (provision and deprovision).

* `api/production/sso_url` - The production endpoint for single sign-on.

* `api/test/base_url` - The test endpoint on which Clever Cloud sends actions requests. Used to test your service when you create an add-on provider. After the add-on creation,`api/production/base_url` is used.

* `api/test/sso_url` - The test endpoint for single sign-on. Used to test your service when you create an add-on provider. After that, the `api/production/sso_url` is used.

## Add-on Provider requests
Expand All @@ -78,7 +69,7 @@

When a customer installs your add-on, Clever Cloud issues a POST request to your service to provision a resource for his app.

The request will be the following:
Clever Cloud will send the following request:

Check warning on line 72 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 72, "column": 14}}}, "severity": "WARNING"}

```json
Request: POST {base_url}
Expand All @@ -105,38 +96,26 @@
The request body contains the following fields:

* `addon_id` - The id we give to your add-on to identify it on our side.

* `owner_id` - The id of the customer this add-on will belong to.

* `owner_name` - The name of the customer. (Actually, the name of the organisation)

* `user_id` - The id of the user that is performing the action of provisioning this
add-on. (The user will do it for the account of `owner_id`).

* `plan` - The slug field for the plan the user chose. You can create
plans in the dashboard once your add-on manifest has been uploaded to
the Clever Cloud platform. We send you the slug of the given plan,
not its name.

* `region` - The region to provision the add-on. As for now, only "EU" will be sent.

* `callback_url` - The URL you can use to get informations about the add-on and the user. This URL is available as soon as the provisioning is done. You can't use this URL during the POST call.

* `callback_url` - The URL you can use to get details about the add-on and the user. This URL is available as soon as the provisioning is done. You can't use this URL during the POST call.

Check warning on line 108 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is done').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is done').", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 108, "column": 136}}}, "severity": "INFO"}
* `logplex_token` - Deprecated, don't use it.

* `options` - String -> String map with options.

The response body contains the following fields:

* `id` - The add-on id as seen from your side. It *MUST* be a String.

* `config` (Optional) - A String -> String map with value for each config\_var defined in your manifest. A key that is not in your config\_vars will be ignored.

* `message` (Optional) - A creation message we will display in the dashboard.

### Deprovisioning
### De-provisioning

When a customer deletes your add-on, Clever Cloud issues a DELETE request to your service to deprovision a ressource for his app.
When a customer deletes your add-on, Clever Cloud issues a DELETE request to your service to de-provision a resource for his app.

The request will be the following:

Expand Down Expand Up @@ -188,7 +167,7 @@

* `addon_id` - The add-on's id from Clever Cloud's POV.

* `callback_url` - URL to call to get more informations about this add-on.
* `callback_url` - URL to call to get more details about this add-on.

* `plan` - The current plan of this add-on.

Expand Down Expand Up @@ -221,7 +200,7 @@

* `name` - The name the user gave to this add-on in the Clever Cloud dashboard.

* `config` - Config vars as you defined during the provision call.
* `config` - Configuration variables as you defined during the provision call.

* `callback_url` - The URL you just called.

Expand All @@ -231,7 +210,7 @@

* `owner_id` - The id of the owner that provisioned the add-on. This should never change.

* `region` - The region this add-on is located in. As for now, we only support "eu".
* `region` - The region this add-on is located in. As for now, only "eu" is supported.

Check warning on line 213 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is located').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is located').", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 213, "column": 37}}}, "severity": "INFO"}

Check failure on line 213 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'eu'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'eu'?", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 213, "column": 70}}}, "severity": "ERROR"}

Check warning on line 213 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is supported').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is supported').", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 213, "column": 74}}}, "severity": "INFO"}

* `domains` - Originally the domains names for the application owning the add-on. We return an empty list.

Expand Down Expand Up @@ -371,9 +350,9 @@
* `id` - The id of the connecting add-on. This is the id you returned on
the provision call.

* `sso_salt` - The sso_salt field defined in your manifest.
* `sso_salt` - The `sso_salt` field defined in your manifest.

* `timestamp` - The timestamp field of the sso request.
* `timestamp` - The timestamp field of the SSO request.

Check warning on line 355 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'SSO', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'SSO', if it's unfamiliar to the audience.", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 355, "column": 44}}}, "severity": "INFO"}

### Sample in Python

Expand All @@ -388,7 +367,7 @@
print token
```

This will return:
This code returns:

```text
'aca601ba464437cbaa12b2fedd7db755c32ddb5e'
Expand Down
45 changes: 22 additions & 23 deletions content/doc/quickstart/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@
## Create a Clever Cloud Account

The API of Clever Cloud uses OAuth 1 to perform authentication actions.
There are two ways to signup to Clever Cloud: **email** or **GitHub login**.
There are two ways to sign up for Clever Cloud: **email** or **GitHub login**.

{{< tabs items="Email Auth, GitHub Auth" >}}

{{< tab >}}
This kind of auth requires a valid and non-temporary disposable e-mail, and a password having at least 6 characters.
This kind of auth requires a valid and non-temporary disposable email, and a password having at least 6 characters.
Do not forget to validate your email by clicking the link you will receive.
{{< /tab >}}

{{< tab >}}

The GitHub signup allows you to create an account or link your existing one to GitHub, in one click.
The GitHub sign up allows you to create an account or link your existing one to GitHub, in one click.
This process asks the following permissions:

* Read your Public Key
Expand Down Expand Up @@ -64,7 +64,7 @@

### How it Works

When you push an application's code to git or via FTP, the platform receives it and checks the resource’s requirements. If they are complete, the deployment is launched. When finished and successful, the application is up and running.
When you push an application's code to git or via FTP, the platform receives it and checks the resource's requirements. If they are complete, the deployment is launched. When finished and successful, the application is up and running.

Check warning on line 67 in content/doc/quickstart/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'FTP', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'FTP', if it's unfamiliar to the audience.", "location": {"path": "content/doc/quickstart/_index.md", "range": {"start": {"line": 67, "column": 51}}}, "severity": "INFO"}

Check warning on line 67 in content/doc/quickstart/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Contractions] Use 'they're' instead of 'they are'.

Raw Output:
{"message": "[Google.Contractions] Use 'they're' instead of 'they are'.", "location": {"path": "content/doc/quickstart/_index.md", "range": {"start": {"line": 67, "column": 124}}}, "severity": "INFO"}

Check warning on line 67 in content/doc/quickstart/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is launched').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is launched').", "location": {"path": "content/doc/quickstart/_index.md", "range": {"start": {"line": 67, "column": 158}}}, "severity": "INFO"}

The log system retrieves all output from the application and displays it in the logs tab of your application in the Clever Cloud console.

Expand Down Expand Up @@ -110,7 +110,7 @@
Choose the language or the framework you want to deploy.

{{< callout emoji="💡" >}}
**Optional:** For PHP applications, you can choose between FTP and Git deployment.
**Optional:** for PHP applications, you can choose between FTP and Git deployment.

Check warning on line 113 in content/doc/quickstart/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'FTP', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'FTP', if it's unfamiliar to the audience.", "location": {"path": "content/doc/quickstart/_index.md", "range": {"start": {"line": 113, "column": 62}}}, "severity": "INFO"}
{{< /callout >}}

#### Fine-tune your scaling configuration
Expand Down Expand Up @@ -139,11 +139,11 @@
{{< tab >}}
*To deploy via Git, you need it installed on your machine. You can find more information on Git website: [git-scm.com](https://git-scm.com)*

*Note:* During the deployment, the .git folder is automatically deleted to avoid security problems. If you need to know which version is used on the server please use the `COMMIT_ID` [environment variable](/reference/reference-environment-variables).
*Note:* during the deployment, the .git folder is automatically deleted to avoid security problems. If you need to know which version is used on the server please use the `COMMIT_ID` [environment variable](/reference/reference-environment-variables).

Check warning on line 142 in content/doc/quickstart/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is used').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is used').", "location": {"path": "content/doc/quickstart/_index.md", "range": {"start": {"line": 142, "column": 137}}}, "severity": "INFO"}

Follow these steps to deploy your application:

1. Get the git deployment url in the application information page, which looks like: `git+ssh://git@push.<zone>.clever-cloud.com/<your_app_id>.git`.
1. Get the git deployment URL in the application information page, which looks like: `git+ssh://git@push.<zone>.clever-cloud.com/<your_app_id>.git`.

2. In your terminal, go to your application repository. If you do not already track your app with git, start by typing:

Expand All @@ -153,7 +153,7 @@
git commit -m "first commit"
```

3. Then, link your local repository to Clever Cloud by providing the Git remote url:
3. Then, link your local repository to Clever Cloud by providing the Git remote URL:

```bash
git remote add <remote-name> <your-git-deployment-url>
Expand All @@ -174,13 +174,13 @@

{{< image "/images/github-deployment-branch.png" "Github deployment branch select" >}}

If you don't find your repository in the list fetched from Github, a workaround is to unlink your account in your profile here : <https://console.clever-cloud.com/users/me/information>, remove **Clever Cloud API** from your Github [Authorized OAuth Apps](https://github.com/settings../applications) and link again your Github account to your Clever Cloud account.
If you don't find your repository in the list fetched from GitHub, a workaround is to unlink your account in your profile here : <https://console.clever-cloud.com/users/me/information>, remove **Clever Cloud API** from your GitHub [Authorized OAuth Apps](https://github.com/settings../applications) and link again your GitHub account to your Clever Cloud account.

**Private GitHub repositories are also supported.**

Caution: in GitHub, private repositories in an ordinary user account are an all-or-nothing deal: either someone has full read write access (i.e., they're a collaborator) or they have no access.
Caution: in GitHub, private repositories in an ordinary user account are an all-or-nothing deal: that is, either someone has full read write access (because they're a collaborator) or they have no access.

However, if you set up an organization, create the repo under the aegis of the organization, and then add the collaborator, you have much more fine-grained control (including giving read-only access to a private repository).
However, if you set up an organization, create the repository under the aegis of the organization, and then add the collaborator, you have much more fine-grained control (including giving read-only access to a private repository).
{{< /tab >}}

{{< tab >}}
Expand All @@ -204,17 +204,16 @@

{{% details title="Git ⋅ Remote is asking for a password" closed="true" %}}

If the remote asks you for a password right after a git push attempt, this may be due to a SSH Key misconfiguration.
If the remote asks you for a password right after a git push attempt, this may be due to a SSH Key configuration error.

**Add your SSH key to your profile here:**
<https://console.clever-cloud.com/users/me/ssh-keys>

The full tutorial about adding SSH key is here: [Adding SSH keys](/account/ssh-keys-management)
The full tutorial about adding SSH key is here: [adding SSH keys](/account/ssh-keys-management)

{{% /details %}}

{{% details title= "Git ⋅ Unable to resolve the reference master" closed="true" %}}
You are probably trying to push from another branch. Remeber that:
You are probably trying to push from another branch. Keep in mind that:

* You can only push to the **master** branch for deployment. Trying to push to another branch will trigger an error.
* You cannot push a tag (which refers to a commit) to the remote repository. If you do so, **no deployment** will be triggered.
Expand All @@ -238,7 +237,7 @@

Indeed, no git repository is created on Clever Cloud because the application is directly cloned from GitHub.

If you have to push directly to a repo in order to deploy an application (eg if you deploy from a CI), then create a non-GitHub app.
If you have to push directly to a repository to deploy an application (eg if you deploy from a CI), then create a non-GitHub app.

{{% /details %}}

Expand Down Expand Up @@ -292,7 +291,7 @@
1. Go to the [Clever Cloud Console](https://console.clever-cloud.com/).
2. Go to the organization in which you want to create the add-on, for example your [personal space](https://console.clever-cloud.com/users/me).
3. Click on **Add an add-on**. This space let you create and configure the add-on according to your needs.
4. Choose which *type* of add-on you want to create. See above the list of available add-ons and their corresponding documentation pages for further information on how they work.
4. Choose which *type* of add-on you want to create. See preceding the list of available add-ons and their corresponding documentation pages for further information on how they work.
5. Select the plan you need for you add-on. You can find details about the pricing, the capacity of the add-on and other specifications on this page or in the corresponding documentation page.
6. Choose with which application you want to link you add-on. Linking an add-on to an application will provide configuration to the application through [environment variables](/develop/env-variables). The environment variables provided by the add-on are available for use in the linked application. If you want to use your add-on alone, just don't link it to any application.
7. Choose the name of the add-on and the region where the add-on will be hosted.
Expand All @@ -307,7 +306,7 @@
1. Go in the organization of your application.
2. Click on the name of the application you want to link with your add-on.
3. Go in the **Service dependencies** section.
4. Select the add-on you want to link under the "Link addons" dropdown menu.
4. Select the add-on you want to link under the "Link add-ons" dropdown menu.
5. Click on the **Link** button of the add-on you want to link to your application.
{{< /tab >}}
{{< /tabs >}}
Expand All @@ -320,11 +319,11 @@
* Per-usage billing: Add-ons based on consumption, like [FS Bucket]({{< ref "doc/addons/fs-bucket" >}}) and [Cellar]({{< ref "doc/addons/cellar.md" >}})

{{< callout type="warning" >}}
**Free Plan:** Add-ons having a free plan are meant for testing purposes, not production usage. These add-ons usually rely on shared resources, resulting in variable, non-guaranteed performances and stability. Shared clusters may not be running the same version as dedicated instances.
**Free Plan:** add-ons having a free plan are meant for testing purposes, not production usage. These add-ons usually rely on shared resources, resulting in variable, non-guaranteed performances and stability. Shared clusters may not be running the same version as dedicated instances.
{{< /callout >}}

{{< callout emoji="📊" >}}
**Your invoice:** Per usage billing will be taken on runtime credits each day, while per-month add-ons will create a new line in the monthly invoice.
**Your invoice:** per usage billing will be taken on runtime credits each day, while per-month add-ons will create a new line in the monthly invoice.
{{< /callout >}}

### Manage your Add-on
Expand All @@ -333,10 +332,10 @@

* **Add-on dashboard:** This screen provides and overview of your add-on and its options, depending on the type of add-on it is.

{{< image "/images/addon-dashboard.png" "Example of the dashoard tab of an add-on" >}}
{{< image "/developers/images/addon-dashboard.png" "Example of the dashoard tab of an add-on" >}}

* **Information tab:** This screen sums-up the characteristics of the selected add-on.
Features and environment variables (if applicable) are shown.
The system shows features and environment variables (if applicable).

Other tabs may be available, depending on the add-on type.

Expand All @@ -348,5 +347,5 @@
2. Click on *Remove add-on*.

{{< callout type="warning" >}}
After deletion of the add-on, all associated data will be removed.
The system removes all associated data after you delete the add-on.
{{< /callout >}}
Loading