diff options
Diffstat (limited to 'doc/integration/akismet.md')
| -rw-r--r-- | doc/integration/akismet.md | 37 |
1 files changed, 20 insertions, 17 deletions
diff --git a/doc/integration/akismet.md b/doc/integration/akismet.md index 7cb8f8b70ce..d290ffa92b9 100644 --- a/doc/integration/akismet.md +++ b/doc/integration/akismet.md @@ -1,11 +1,17 @@ +--- +stage: none +group: unassigned +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +--- + # Akismet -GitLab leverages [Akismet](https://akismet.com/) to protect against spam. Currently +GitLab leverages [Akismet](https://akismet.com/) to protect against spam. GitLab uses Akismet to prevent the creation of spam issues on public projects. Issues -created via the web UI or the API can be submitted to Akismet for review. +created through the web UI or the API can be submitted to Akismet for review. -Detected spam will be rejected, and an entry in the "Spam Log" section in the -Admin page will be created. +Detected spam is rejected, and an entry is added in the **Spam Log** section of the +Admin page. Privacy note: GitLab submits the user's IP and user agent to Akismet. @@ -17,11 +23,11 @@ In earlier GitLab versions, this only applied to API and non-project members. To use Akismet: -1. Go to the URL: <https://akismet.com/account/> -1. Sign-in or create a new account. -1. Click on **Show** to reveal the API key. +1. Go to the [Akismet sign-in page](https://akismet.com/account/). +1. Sign in or create a new account. +1. Click **Show** to reveal the API key. 1. Go to **Admin Area > Settings > Reporting** (`/admin/application_settings/reporting`). -1. Check the **Enable Akismet** checkbox. +1. Select the **Enable Akismet** checkbox. 1. Fill in the API key from step 3. 1. Save the configuration. @@ -29,23 +35,20 @@ To use Akismet: ## Training -NOTE: **Note:** -Training the Akismet filter is only available in GitLab 8.11 and later. - -As a way to better recognize between spam and ham, you can train the Akismet +To better differentiate between spam and ham, you can train the Akismet filter whenever there is a false positive or false negative. When an entry is recognized as spam, it is rejected and added to the Spam Logs. -From here you can review if they are really spam. If one of them is not really +From here you can review if entries are really spam. If one of them is not really spam, you can use the **Submit as ham** button to tell Akismet that it falsely recognized an entry as spam.  -If an entry that is actually spam was not recognized as such, you will be able -to also submit this to Akismet. The **Submit as spam** button will only appear -to admin users. +If an entry that is actually spam was not recognized as such, you can also submit +this information to Akismet. The **Submit as spam** button is only displayed +to administrator users.  -Training Akismet will help it to recognize spam more accurately in the future. +Training Akismet helps it to recognize spam more accurately in the future. |