From 9dfbc12e80c6d2629326220790cc148e2051689b Mon Sep 17 00:00:00 2001 From: Philippe PITTOLI Date: Tue, 16 Apr 2024 22:40:26 +0200 Subject: [PATCH] Wording. --- src/App/Page/Administration.purs | 2 +- src/App/Page/DomainList.purs | 2 +- src/App/Page/Home.purs | 4 ++-- src/App/Page/Setup.purs | 2 +- src/App/Page/Zone.purs | 2 +- src/App/Text/Explanations.purs | 6 +++--- src/App/Validation/DNS.purs | 4 ++-- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/App/Page/Administration.purs b/src/App/Page/Administration.purs index df97df7..025a3b1 100644 --- a/src/App/Page/Administration.purs +++ b/src/App/Page/Administration.purs @@ -1,5 +1,5 @@ {- Administration interface. - Allows to: + Enables to: - add, remove, search users - TODO: validate users - TODO: change user password diff --git a/src/App/Page/DomainList.purs b/src/App/Page/DomainList.purs index 0c9a15f..9223910 100644 --- a/src/App/Page/DomainList.purs +++ b/src/App/Page/DomainList.purs @@ -1,7 +1,7 @@ -- | `App.DomainListInterface` is a simple component with the list of own domains -- | and a form to add a new domain. -- | --- | This interface allows to: +-- | This interface enables to: -- | - display the list of own domains -- | - show and select accepted domains (TLDs) -- | - create new domains diff --git a/src/App/Page/Home.purs b/src/App/Page/Home.purs index 81dee30..74324d6 100644 --- a/src/App/Page/Home.purs +++ b/src/App/Page/Home.purs @@ -117,7 +117,7 @@ render _ = HH.div_ """ , link "https://git.baguette.netlib.re/Baguette/dnsmanager" "dnsmanagerd" """ - the dns manager daemon, used as an interactive database, allowing clients + the dns manager daemon, used as an interactive database, enabling clients to ask for domains, then handle the domain zones; """ , link "https://git.baguette.netlib.re/Baguette/dnsmanager-webclient" @@ -137,7 +137,7 @@ render _ = HH.div_ """ , link "https://git.baguette.netlib.re/Baguette/dodb.cr" "dodb" """ - the Document Oriented DataBase, allowing to store serialized objects + the Document Oriented DataBase, enabling to store serialized objects (a Zone, a User, etc.) in simple files as opposed to the usual complexity of traditional databases. """ diff --git a/src/App/Page/Setup.purs b/src/App/Page/Setup.purs index f54d1bf..22d086b 100644 --- a/src/App/Page/Setup.purs +++ b/src/App/Page/Setup.purs @@ -1,4 +1,4 @@ --- | `App.SetupInterface` allows users to change their password or their email address. +-- | `App.SetupInterface` enables users to change their password or their email address. -- | Users can also erase their account. module App.Page.Setup where diff --git a/src/App/Page/Zone.purs b/src/App/Page/Zone.purs index a380477..457e67d 100644 --- a/src/App/Page/Zone.purs +++ b/src/App/Page/Zone.purs @@ -1,6 +1,6 @@ -- | `App.ZoneInterface` provides an interface to display and modify a DNS zone. -- | --- | This interface allows to: +-- | This interface enables to: -- | - display all resource records of a zone (SOA, NS, A, AAAA, CNAME, TXT, MX, SRV) -- | - provide dedicated interfaces for SPF and DKIM (TODO: DMARC) -- | - add, modify, remove resource records diff --git a/src/App/Text/Explanations.purs b/src/App/Text/Explanations.purs index 5afb4eb..bfece98 100644 --- a/src/App/Text/Explanations.purs +++ b/src/App/Text/Explanations.purs @@ -148,7 +148,7 @@ dkim_introduction :: forall w i. Array (HH.HTML w i) dkim_introduction = [ Bulma.p """ DKIM is a way to share a public signature key for the domain. - This allows emails to be signed by the sender, and for the receiver to prove the origin of the mail. + This enables emails to be signed by the sender and for the receiver to verify the origin of the mail. """ , HH.p [] [ HH.text """ @@ -168,7 +168,7 @@ dmarc_introduction = DMARC is a spam mitigation mechanism on top of SPF and DKIM. Upon receiving a mail, the server checks whether the "From:" field of the mail is consistent with the SPF and DKIM records of the sender's domain. - The DMARC record tells what to do with the mail in case of an inconsistency, and DMARC allows to define email + The DMARC record tells what to do with the mail in case of an inconsistency, and DMARC enables to define email addresses that should receive error reports. """ ] @@ -176,7 +176,7 @@ dmarc_introduction = dmarc_policy :: forall w i. Array (HH.HTML w i) dmarc_policy = [ Bulma.p """ - DMARC record allows to tell receivers what to do with a non-conforming message; + DMARC record enables to tell receivers what to do with a non-conforming message; a message that wasn't properly secured with SPF and DKIM. """ , Bulma.p """ diff --git a/src/App/Validation/DNS.purs b/src/App/Validation/DNS.purs index 2283306..209a964 100644 --- a/src/App/Validation/DNS.purs +++ b/src/App/Validation/DNS.purs @@ -108,7 +108,7 @@ txt_parser = do pos <- G.current_position then pure $ CU.fromCharArray v else G.Parser \_ -> G.failureError pos (Just $ TXTTooLong max_txt nbchar) --- | `parse` allows to run any parser based on `GenericParser` and provide a validation error. +-- | `parse` enables to run any parser based on `GenericParser` and provide a validation error. -- | The actual validation error contains the parser's error including the position. parse :: forall e v. G.Parser e v -> String -> ((G.Error e) -> Error) -> V (Array Error) v parse (G.Parser p) str c = case p { string: str, position: 0 } of @@ -273,7 +273,7 @@ validationSPF form = ado -- | Accepted RSA key sizes = 2048 or 4096 bits, 256 bits for ED25519. -- | -- | Since the public key representation for the RSA algorithm is in PKCS format (RFC 5958) --- | then converted in PEM (RFC 7468), and knowing this format allows some optional parameters, +-- | then converted in PEM (RFC 7468), and knowing this format enables some optional parameters, -- | it is not possible to expect an exact size for the public key input. -- | Consequently, we expect *at least* an input of 250 bytes for public key, loosely leading -- | to accept key sizes of at least 2048 bits. Maximum allowed key size is also arbitrary.