Basic email system: Big overhaul of grammar and formatting (Revision 2) #1864

neelchauhan · 2024-03-03T17:08:49Z

It seemed my previous PR #1854 got prematurely merged and subsequently reverted in #1863, so here is a revised version.

Author checklist (Completed by original Author)

Good fit for the Rocky Linux project? Title and Author Metatags inserted ?
If applicable, steps and instructions have been tested to work
Initial self-review to fix basic typos and grammar completed

Rocky Documentation checklist (Completed by Rocky team)

1st Pass (Document is good fit for project and author checklist completed)
2nd Pass (Technical Review - check for technical correctness)
3rd Pass (Detailed Editorial Review and Peer Review)
Final approval (Final Review)

sspencerwire · 2024-03-03T19:57:55Z

@jimcat8 Please review these changes. @wsoyinka I'm not going to approve or merge this PR until I know that it is in its final state. @neelchauhan Thank you for your work!

docs/guides/email/02-basic-email-system.md

SergeCroise · 2024-03-04T00:40:52Z

docs/guides/email/02-basic-email-system.md

@@ -210,32 +232,30 @@ Mysql > insert into virtual_aliases(id,domain_id,source,destination) values(1,1,
 Mysql > insert into virtual_aliases(id,domain_id,source,destination) values(2,1,'[email protected]','[email protected]');
 ```

-Here I have not inserted the ciphertext password for the relevant email users, which requires the use of `doveadm pw -s SHA512-crypt -p twotestandtwo` command. See [here](#ap1)
+The password entries for the relevant email users are not shown here, as it requires the use of `doveadm pw -s SHA512-crypt -p twotestandtwo` command. See [here](#ap1)


As a translator, I would prefer to put the command in a separate line, e.g., something similar to:

The password entries for the relevant email users are not shown here, as it requires the use of the following command:

doveadm pw -s SHA512-crypt -p twotestandtwo

See here.

What is the meaning of the other translators?

docs/guides/email/02-basic-email-system.md

SergeCroise

(feel free to modify or revert my suggestions)

docs/guides/email/02-basic-email-system.md

SergeCroise · 2024-03-04T00:47:34Z

docs/guides/email/02-basic-email-system.md

+
+```bash
+Shell(192.168.100.7) > systemctl enable --now dovecot
+```

 !!! info 


Suggested change

!!! info

!!! info "Info"

We have discussed this before @SergeCroise, but adding the "Info" and "Warning" to custom titles isn't required. In fact, I think we discussed that translators could decide if they wanted to add the translated title to the admonition themselves. If I recall, that was the consensus decision, wasn't it?

sspencerwire · 2024-03-04T14:46:18Z

@jimcat8: What is it that you don't like about the fenced code-block changes? The title of the fenced code block is a required markdown element (```bash) so I'm guessing that this is not what you are arguing about? Please clarify for @neelchauhan what you don't want.

Co-authored-by: Serge Croisé <[email protected]>

wsoyinka · 2024-03-04T15:46:36Z

docs/guides/email/02-basic-email-system.md

 !include auth-sql.conf.ext
 ```

 ```bash
-Shell(192.168.100.6) > vim /etc/dovecot/conf.d/10-master.conf
-...
+Shell(192.168.100.7) > vim /etc/dovecot/conf.d/10-master.conf


@jimcat8 and @neelchauhan

what is the correct IP that should appear here - 192.168.100.6 (original) OR 192.168.100.7 (new) ?

github-actions · 2024-03-04T15:47:33Z

Test results for a9c1da2:

Number of broken URLs: 3

URL,RESULT,FILENAME
 https://www.linode.com/docs/guides/beginners-guide-to-lxd-reverse-proxy,failed,guides/containers/lxd_web_servers.md
 https://docs.rockylinux.org/gemstones/docker/,failed,guides/containers/rancher_and_kubernetes.md
 https://csrc.nist.gov/projects/security-content-automation-protocol,failed,books/disa_stig/disa_stig_part2.md

wsoyinka · 2024-03-04T15:48:01Z

docs/guides/email/02-basic-email-system.md


-    Don't write the above grammar on one line, such as this--"userdb {driver = sql args = uid=vmail gid=vmail home=/var/mail/vhosts/%d/%n}". Otherwise, it won't work.
+```bash
+Shell(192.168.100.7) > vim /etc/dovecot/dovecot-sql.conf.ext


@jimcat8 and @neelchauhan

what is the correct IP that should appear here - 192.168.100.6 (original) OR 192.168.100.7 (new) ?

@jimcat8 and @neelchauhan

what is the correct IP that should appear here - 192.168.100.6 (original) OR 192.168.100.7 (new) ?

The beginning of the document already indicates that this is an email system composed of three machines.

jimcat8 · 2024-03-04T15:53:30Z

My idea is not to adjust the basic style or format, but only to change the wording of the text, because the content of this document (02-Basic-Email-Syst.md) is relatively complete.
Just like this “PR” (# 1865)

wsoyinka

@jimcat8 :

Please review and confirm that specific IP address changes at the prompt are correct throughout the document(s).

192.168.100.5 Vs 192.168.100.6 Vs. 192.168.100.7

wsoyinka · 2024-03-04T15:48:50Z

docs/guides/email/02-basic-email-system.md

+Next, edit the mail storage configuration:
+
+```bash
+Shell(192.168.100.7) > vim /etc/dovecot/conf.d/10-mail.conf


@jimcat8 and @neelchauhan

what is the correct IP that should appear here - 192.168.100.6 (original) OR 192.168.100.7 (new) ?

192.168.100.6

wsoyinka · 2024-03-04T15:49:34Z

docs/guides/email/02-basic-email-system.md

+First, edit the Dovecot configuration:
+
+```bash
+Shell(192.168.100.7) > vim /etc/dovecot/dovecot.conf


@jimcat8 and @neelchauhan . Especially @jimcat8

what is the correct IP that should appear here - 192.168.100.6 (original) OR 192.168.100.7 (new) ?

192.168.100.6

wsoyinka · 2024-03-04T15:50:29Z

docs/guides/email/02-basic-email-system.md


 ```bash
-Shell(192.168.100.6) > tree /etc/dovecot/
+Shell(192.168.100.7) > tree /etc/dovecot/


@jimcat8 :

what is the correct IP that should appear here - 192.168.100.6 (original) OR 192.168.100.7 (new) ?

192.168.100.6

wsoyinka · 2024-03-04T15:50:58Z

docs/guides/email/02-basic-email-system.md

-Shell(192.168.100.6) > systemctl start postfix.service
-Shell(192.168.100.6) > postfix check
-Shell(192.168.100.6) > postfix status
+Shell(192.168.100.7) > systemctl start postfix.service


@jimcat8 :

what is the correct IP that should appear here - 192.168.100.6 (original) OR 192.168.100.7 (new) ?

192.168.100.6

wsoyinka · 2024-03-04T15:51:38Z

docs/guides/email/02-basic-email-system.md

 ENCRYPT_METHOD SHA512
 ```

 We can see its structure in the /etc/shadow file:

 ```bash
-Shell(192.168.100.5) > grep -i root /etc/shadow | cut -f 2 -d ":"
+Shell(192.168.100.7) > grep -i root /etc/shadow | cut -f 2 -d ":"


@jimcat8 :

what is the correct IP that should appear here - 192.168.100.5 (original) OR 192.168.100.7 (new) ?

192.168.100.5

wsoyinka · 2024-03-04T15:51:55Z

docs/guides/email/02-basic-email-system.md


 ```bash
-Shell(192.168.100.5) > grep -i method /etc/login.defs
+Shell(192.168.100.7) > grep -i method /etc/login.defs


@jimcat8 :

what is the correct IP that should appear here - 192.168.100.5 (original) OR 192.168.100.7 (new) ?

192.168.100.5

sspencerwire · 2024-03-05T15:50:37Z

@neelchauhan @jimcat8 Because of the errors made in the IP addresses of the prompts, and because this PR now conflicts with a grammar PR pushed and merged yesterday (which did not deal with the technical aspects of this document), I'm going to have to elect to close this PR yet again. @neelchauhan If you see any wording changes that still need to be dealt with, without messing with the technical aspects of the document, I'm more than willing to merge those. Thanks to all.

Basic email system: Big overhaul of grammar and formatting (Revision 2)

2ed622b

SergeCroise reviewed Mar 4, 2024

View reviewed changes

docs/guides/email/02-basic-email-system.md Outdated Show resolved Hide resolved

SergeCroise reviewed Mar 4, 2024

View reviewed changes

docs/guides/email/02-basic-email-system.md Outdated Show resolved Hide resolved

SergeCroise reviewed Mar 4, 2024

View reviewed changes

wsoyinka and others added 3 commits March 4, 2024 10:39

Update docs/guides/email/02-basic-email-system.md

eee8b87

Co-authored-by: Serge Croisé <[email protected]>

Update docs/guides/email/02-basic-email-system.md

a9c1da2

Co-authored-by: Serge Croisé <[email protected]>

Update docs/guides/email/02-basic-email-system.md

1e244d8

Co-authored-by: Serge Croisé <[email protected]>

wsoyinka reviewed Mar 4, 2024

View reviewed changes

sspencerwire closed this Mar 5, 2024

neelchauhan mentioned this pull request Mar 5, 2024

Basic email system: Big overhaul of grammar and formatting (Revision 3) #1892

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Basic email system: Big overhaul of grammar and formatting (Revision 2) #1864

Basic email system: Big overhaul of grammar and formatting (Revision 2) #1864

neelchauhan commented Mar 3, 2024 •

edited by sspencerwire

Loading

sspencerwire commented Mar 3, 2024

SergeCroise Mar 4, 2024

SergeCroise left a comment •

edited

Loading

SergeCroise Mar 4, 2024

sspencerwire Mar 4, 2024

sspencerwire commented Mar 4, 2024

wsoyinka Mar 4, 2024

github-actions bot commented Mar 4, 2024

wsoyinka Mar 4, 2024

jimcat8 Mar 4, 2024

jimcat8 commented Mar 4, 2024

wsoyinka left a comment

wsoyinka Mar 4, 2024

neelchauhan Mar 5, 2024

wsoyinka Mar 4, 2024

neelchauhan Mar 5, 2024

wsoyinka Mar 4, 2024

neelchauhan Mar 5, 2024

wsoyinka Mar 4, 2024

neelchauhan Mar 5, 2024

wsoyinka Mar 4, 2024

neelchauhan Mar 5, 2024

wsoyinka Mar 4, 2024

neelchauhan Mar 5, 2024

sspencerwire commented Mar 5, 2024

Basic email system: Big overhaul of grammar and formatting (Revision 2) #1864

Basic email system: Big overhaul of grammar and formatting (Revision 2) #1864

Conversation

neelchauhan commented Mar 3, 2024 • edited by sspencerwire Loading

Author checklist (Completed by original Author)

Rocky Documentation checklist (Completed by Rocky team)

sspencerwire commented Mar 3, 2024

Choose a reason for hiding this comment

SergeCroise left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sspencerwire commented Mar 4, 2024

Choose a reason for hiding this comment

github-actions bot commented Mar 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimcat8 commented Mar 4, 2024

wsoyinka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sspencerwire commented Mar 5, 2024

neelchauhan commented Mar 3, 2024 •

edited by sspencerwire

Loading

SergeCroise left a comment •

edited

Loading