From bf69ea8ccc9877fb4d18c811abe958c6e1a3f1f1 Mon Sep 17 00:00:00 2001 From: Anael Mobilia Date: Mon, 15 May 2023 00:07:07 +0200 Subject: [PATCH] Fix typos (#413) Co-authored-by: Anael Mobilia --- docs/source/elasticsearch.md | 6 +++--- docs/source/installation.md | 7 +++---- docs/source/kibana.md | 2 +- docs/source/mailing-lists.md | 2 +- docs/source/output.md | 2 +- 5 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/source/elasticsearch.md b/docs/source/elasticsearch.md index 1c38f1e..856cf09 100644 --- a/docs/source/elasticsearch.md +++ b/docs/source/elasticsearch.md @@ -29,7 +29,7 @@ which will cause it to crash under a heavy load. To fix this, increase the minimum and maximum JVM heap sizes in `/etc/elasticsearch/jvm.options` to more reasonable levels, depending on your server's resources. -Make sure the system has at least 2 GB more RAM then the assigned JVM +Make sure the system has at least 2 GB more RAM than the assigned JVM heap size. Always set the minimum and maximum JVM heap sizes to the same @@ -180,7 +180,7 @@ sudo systemctl restart elasticsearch Now that Elasticsearch is up and running, use `parsedmarc` to send data to it. -Download (right click the link and click save as) [export.ndjson]. +Download (right-click the link and click save as) [export.ndjson]. Connect to kibana using the "elastic" user and the password you previously provide on the console ("End Kibana configuration" part). @@ -219,7 +219,7 @@ Kibana index patterns with versions that match the upgraded indexes: index patterns 4. Click Delete 5. Click Delete on the conformation message -6. Download (right click the link and click save as) +6. Download (right-click the link and click save as) the latest version of [export.ndjson] 7. Import `export.ndjson` by clicking Import from the Kibana Saved Objects page diff --git a/docs/source/installation.md b/docs/source/installation.md index cea325d..c34abfd 100644 --- a/docs/source/installation.md +++ b/docs/source/installation.md @@ -28,8 +28,7 @@ https_proxy=https://prox-server:3128 ftp_proxy=http://prox-server:3128 ``` -This will set the the proxy up for use system-wide, including for -`parsedmarc`. +This will set the proxy up for use system-wide, including for `parsedmarc`. ::: :::{warning} @@ -49,7 +48,7 @@ Starting in `parsedmarc` 7.1.0, a static copy of the `parsedmarc`, under the terms of the [Creative Commons Attribution 4.0 International License]. as a fallback if the [MaxMind GeoLite2 Country database] is not -installed However, `parsedmarc` cannot install updated versions of +installed. However, `parsedmarc` cannot install updated versions of these databases as they are released, so MaxMind's databases and the [geoipupdate] tool is still the preferable solution. @@ -91,7 +90,7 @@ regulations][to comply with various privacy regulations]. Start by [registering for a free GeoLite2 account], and signing in. -Then, navigate the to the [License Keys] page under your account, +Then, navigate to the [License Keys] page under your account, and create a new license key for the version of `geoipupdate` that was installed. diff --git a/docs/source/kibana.md b/docs/source/kibana.md index 67c224e..bf2cf1a 100644 --- a/docs/source/kibana.md +++ b/docs/source/kibana.md @@ -6,7 +6,7 @@ results from incoming DMARC reports. :::{note} The default dashboard is DMARC Summary. To switch between dashboards, -click on the Dashboard link in the left side menu of Kibana. +click on the Dashboard link on the left side menu of Kibana. ::: ## DMARC Summary diff --git a/docs/source/mailing-lists.md b/docs/source/mailing-lists.md index ede5c8a..71b8975 100644 --- a/docs/source/mailing-lists.md +++ b/docs/source/mailing-lists.md @@ -6,7 +6,7 @@ list is spoofing your from address, and modifying the subject, footer, or other part of the message, thereby breaking the DKIM signature. -### Mailing list list best practices +### Mailing list best practices Ideally, a mailing list should forward messages without altering the headers or body content at all. [Joe Nelson] does a fantastic job of diff --git a/docs/source/output.md b/docs/source/output.md index 4838ed3..f676891 100644 --- a/docs/source/output.md +++ b/docs/source/output.md @@ -89,7 +89,7 @@ draft,acme.com,noreply-dmarc-support@acme.com,http://acme.com/dmarc/support,9391 ## Sample forensic report output -Thanks to Github user [xennn](https://github.com/xennn) for the anonymized +Thanks to GitHub user [xennn](https://github.com/xennn) for the anonymized [forensic report email sample](). ### JSON forensic report