Skip to content

Commit 9ae2220

Browse files
Remove most instances of "Please" (#1076)
As per our [writing guidelines](https://docs.elastic.dev/tech-writing-guidelines/word-choice): > In most cases, please is unnecessary. This PR removes almost all instances of "Please", rewriting the sentences when necessary. I only kept "please" in sample error messages or logs. Note: I don't usually open PRs this big, but I wanted to run a sweep to get a feeling of the docs repo. --------- Co-authored-by: Janeen Mikell Roberts <[email protected]>
1 parent 1c3db58 commit 9ae2220

File tree

135 files changed

+189
-189
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+189
-189
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This repo contains source files for Elastic documentation.
66

77
## Contribute
88

9-
If you find any bugs in our documentation, or want to request an enhancement, please [open an issue](https://github.com/elastic/docs-content/issues). We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
9+
If you find any bugs in our documentation, or want to request an enhancement, [open an issue](https://github.com/elastic/docs-content/issues). We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
1010

1111
We write our docs in markdown. See our [syntax guide](https://elastic.github.io/docs-builder/syntax/index.html) for examples and additional functionality.
1212

deploy-manage/cloud-organization/billing/billing-faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ $$$faq-payment$$$What are the available payment methods on {{ecloud}}?
6969
: For month-to-month payments only credit cards are accepted. We also allow payments by bank transfer for annual subscriptions.
7070

7171
$$$faq-contact$$$Who can I contact for more information?
72-
: If you have any further questions about your credit card statement, billing, or receipts, please send an email to `[email protected]` or open a [Support case](../../../troubleshoot/index.md) using the *Billing issue* category.
72+
: If you have any further questions about your credit card statement, billing, or receipts, send an email to `[email protected]` or open a [Support case](../../../troubleshoot/index.md) using the *Billing issue* category.
7373

7474
$$$faq-charge$$$Why is my credit card charged?
7575
: If you are on a monthly plan, the charge is a recurring fee for using {{ecloud}}. The fee is normally charged at the start of each month, but it can also be charged at other times during the month. If a charge is unsuccessful, we will try to charge your card again at a later date.
@@ -90,7 +90,7 @@ $$$faq-deleteaccount$$$How can I delete my {{ecloud}} account?
9090
: To have your account removed, you can contact support through the {{ecloud}} [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) or use one of these [alternative contact methods](../../../troubleshoot/index.md). For details about our data erasure policy, check [Privacy Rights and Choices](https://www.elastic.co/legal/privacy-statement#privacy-rights-and-choices?page=docs&placement=docs-body) in our General Privacy Statement.
9191

9292
$$$faq-refund$$$Can I get a refund?
93-
: Charges are non-refundable, but once you delete a deployment we’ll stop charging you for that deployment immediately. You only pay for what you use and you can stop using the service at any time. For any special considerations warranting a potential refund, please use the {{ecloud}} Console [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) to open a support case and select *Billing issue* as the category. To ensure quick processing, be sure to provide detail about the reasons for the refund request as well as other matters pertaining to the issue. For other ways to open a Support case, check [Contact us](../../../troubleshoot/index.md).
93+
: Charges are non-refundable, but once you delete a deployment we’ll stop charging you for that deployment immediately. You only pay for what you use and you can stop using the service at any time. For any special considerations warranting a potential refund, use the {{ecloud}} Console [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) to open a support case and select *Billing issue* as the category. To ensure quick processing, be sure to provide detail about the reasons for the refund request as well as other matters pertaining to the issue. For other ways to open a Support case, check [Contact us](../../../troubleshoot/index.md).
9494

9595
$$$faq-included$$$What is included in my paid {{ech}} deployment?
9696
: All subscription tiers for {{ech}} include the following free allowance:

deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ navigation_title: Ansible playbook
1111

1212
If you already use Ansible in your business for provisioning, configuration management, and application deployment, you can use the ECE Ansible playbook to get up and running with {{ece}} faster, on any cloud provider.
1313

14-
Please note that the ECE Ansible playbook is a community project, supported by Elastic, available on GitHub: [elastic/ansible-elastic-cloud-enterprise](https://github.com/elastic/ansible-elastic-cloud-enterprise). Elastic welcomes all community contributions to the repository and will validate any changes on a best-effort basis.
14+
Note that the ECE Ansible playbook is a community project, supported by Elastic, available on GitHub: [elastic/ansible-elastic-cloud-enterprise](https://github.com/elastic/ansible-elastic-cloud-enterprise). Elastic welcomes all community contributions to the repository and will validate any changes on a best-effort basis.
1515

deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
139139
[...]
140140
```
141141

142-
6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Please note that multiple env variables in that configuration file exists — use the one in the [engine] section.
142+
6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Note that multiple env variables in that configuration file exists — use the one in the [engine] section.
143143

144144
Example:
145145

@@ -304,7 +304,7 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
304304
sudo install -o elastic -g elastic -d -m 700 /mnt/data/docker
305305
```
306306

307-
25. If you want to use FirewallD, please ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:
307+
25. If you want to use FirewallD, ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:
308308

309309
```sh
310310
sudo systemctl disable firewalld

deploy-manage/deploy/cloud-enterprise/ece-ha.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ If you’re using a [private Docker registry server](ece-install-offline-with-re
5757

5858
Avoid deleting containers unless explicitly instructed by Elastic Support or official documentation. Doing so may lead to unexpected issues or loss of access to your {{ece}} platform. For more details, refer to [](/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md).
5959

60-
If in doubt, please [contact support for help](/troubleshoot/index.md#contact-us).
60+
If in doubt, [contact support for help](/troubleshoot/index.md#contact-us).

deploy-manage/deploy/cloud-enterprise/ece-hardware-prereq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,5 @@ The size of your ECE deployment has a bearing on the JVM heap sizes that you sho
6161
The ECE management services provided by the coordinators and directors require fast SSD storage to work correctly. For smaller deployments that co-locate the ECE management services with proxies and allocators on the same hosts, you must use fast SSD storage for your entire deployment. If SSD-only storage is not feasible, [some of the ECE management services need to be separated](ece-roles.md).
6262

6363
::::{note}
64-
When using SSDs on an external (shared) storage system, please check with your storage vendor whether TRIM [should be disabled](https://www.elastic.co/blog/is-your-elasticsearch-trimmed) on the ECE hosts to avoid unnecessary stress on the storage system.
64+
When using SSDs on an external (shared) storage system, check with your storage vendor whether TRIM [should be disabled](https://www.elastic.co/blog/is-your-elasticsearch-trimmed) on the ECE hosts to avoid unnecessary stress on the storage system.
6565
::::

deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ mapped_pages:
99
# Wildcard DNS record [ece-wildcard-dns]
1010

1111
::::{warning}
12-
We do not recommend using `ip.es.io` for production systems. Please set up your own domain name and DNS resolver for production. We do not guarantee uptime with `ip.es.io`.
12+
Don't use `ip.es.io` for production systems. Set up your own domain name and DNS resolver for production. We do not guarantee uptime with `ip.es.io`.
1313
::::
1414

1515
By default, {{ece}} uses the external `ip.es.io` service provided by Elastic to resolve virtual {{es}} cluster host names in compliance with RFC1918. The service works by resolving host names of the form `<ip>.ip.es.io` to `<ip>`. In the case of {{ece}}, each cluster is assigned a virtual host name of the form `<cluster id>.<proxy ip address>.ip.es.io:<port>`, such as `6dfc65aae62341e18a8b7692dcc97186.10.8.156.132.ip.es.io:9243`. The `ip.es.io` service simply resolves the virtual host name of the cluster to the proxy address which is specified during installation, `10.8.156.132` in our example, so that client requests are sent to the proxy. The proxy then extracts the cluster ID from the virtual host name of the cluster and uses its internal routing table to route the request to the right allocator.

deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Using Docker or Podman as container runtime is a configuration local to the host
169169
[...]
170170
```
171171

172-
6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Please note that multiple env variables in that configuration file exists — use the one in the [engine] section.
172+
6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Note that multiple env variables in that configuration file exists — use the one in the [engine] section.
173173

174174
Example:
175175

@@ -334,7 +334,7 @@ Using Docker or Podman as container runtime is a configuration local to the host
334334
sudo install -o elastic -g elastic -d -m 700 /mnt/data/docker
335335
```
336336

337-
25. If you want to use FirewallD, please ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:
337+
25. If you want to use FirewallD, ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:
338338

339339
```sh
340340
sudo systemctl disable firewalld

deploy-manage/deploy/cloud-enterprise/migrate-to-podman-5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Following are the supported upgrade paths for Podman 5 in {{ece}}.
2323
Podman `5.2.2-13` is only supported when conducting a **fresh {{ece}} installation** or performing a **grow-and-shrink update** from Docker or Podman 4.
2424

2525
For **in-place updates**, it is recommended to use Podman `5.2.2-9`, since upgrades to versions `5.2.2-11` and `5.2.2-13` are affected by a known [memory leak issue](https://github.com/containers/podman/issues/25473).
26-
When performing an in-place update, please make sure to configure the Podman version to be locked at version `5.2.2-9.*`, by following the instructions below.
26+
When performing an in-place update, make sure to configure the Podman version to be locked at version `5.2.2-9.*`, by following the instructions below.
2727

2828
```sh
2929
## Install versionlock

deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ spec:
241241
...
242242
```
243243

244-
Please note that the environment variables related to policy selection mentioned in the {{agent}} [docs](/reference/fleet/agent-environment-variables.md) like `FLEET_SERVER_POLICY_ID` will be managed by the ECK operator.
244+
Note that the environment variables related to policy selection mentioned in the {{agent}} [docs](/reference/fleet/agent-environment-variables.md) like `FLEET_SERVER_POLICY_ID` will be managed by the ECK operator.
245245

246246

247247
## Running as a non-root user [k8s-elastic-agent-running-as-a-non-root-user]

0 commit comments

Comments
 (0)