Skip to content
Snippets Groups Projects
Commit 27798420 authored by ml bonhomme's avatar ml bonhomme :bee:
Browse files

Update system checks doc URL + minor wording / missing punctuation updates

parent 8f709a1d
No related branches found
No related tags found
1 merge request!2425Update system checks doc URL + minor wording / missing punctuation updates
......@@ -2,8 +2,8 @@
Arkindex-specific Django system checks.
If you make any changes to those checks, you should consider updating the system
checks documentation on the wiki:
<https://wiki.vpn/en/arkindex/deploy/checks>
checks documentation in the Arkindex documentation:
<https://doc.arkindex.org/deployment/checks>
"""
import os
import re
......@@ -48,7 +48,7 @@ def api_urls_check(*args, **kwargs):
return [
Error(
"This API URL misses a mandatory ending /",
"This API URL is missing a mandatory ending /",
hint=str(url),
id="arkindex.E001",
)
......@@ -72,7 +72,7 @@ def local_imageserver_check(*args, **kwargs):
ImageServer.objects.get(id=local_id)
except ImageServer.DoesNotExist:
return [Warning(
f"Local ImageServer with ID {local_id} does not exist",
f"Local ImageServer with ID {local_id} does not exist.",
hint=f"settings.LOCAL_IMAGESERVER_ID = {local_id}",
id="arkindex.W009",
)]
......@@ -93,7 +93,7 @@ def ponos_env_check(*args, **kwargs):
if variable not in env:
errors.append(Warning(
f"The {variable} environment variable should be defined "
"to allow API client autoconfiguration in Ponos tasks",
"to allow API client autoconfiguration in Ponos tasks.",
hint=f"`ponos.default_env` in {settings.CONFIG_PATH}",
id="arkindex.W006",
))
......
......@@ -29,7 +29,7 @@ class ChecksTestCase(TestCase):
api_urls_check(),
[
Error(
"This API URL misses a mandatory ending /",
"This API URL is missing a mandatory ending /",
hint=str(bad_url),
id="arkindex.E001",
)
......@@ -47,7 +47,7 @@ class ChecksTestCase(TestCase):
with self.settings(LOCAL_IMAGESERVER_ID=42):
self.assertListEqual(local_imageserver_check(), [
Warning(
"Local ImageServer with ID 42 does not exist",
"Local ImageServer with ID 42 does not exist.",
hint="settings.LOCAL_IMAGESERVER_ID = 42",
id="arkindex.W009",
),
......@@ -72,13 +72,13 @@ class ChecksTestCase(TestCase):
self.assertListEqual(ponos_env_check(), [
Warning(
"The ARKINDEX_API_URL environment variable should be defined "
"to allow API client autoconfiguration in Ponos tasks",
"to allow API client autoconfiguration in Ponos tasks.",
hint="`ponos.default_env` in /somewhere/config.yml",
id="arkindex.W006",
),
Warning(
"The ARKINDEX_API_CSRF_COOKIE environment variable should be defined "
"to allow API client autoconfiguration in Ponos tasks",
"to allow API client autoconfiguration in Ponos tasks.",
hint="`ponos.default_env` in /somewhere/config.yml",
id="arkindex.W006",
),
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment