#207 "Changing SELinux states and modes" needs review
Opened 4 years ago by hhlp. Modified a year ago


Talked a bit to @mjahoda about this:

  • The title of the last section, "Changing SELinux Modes at Boot Time", is the only one in title case in the doc; switch it to sentence case to match the other.

  • Throughout the doc, there are references to changing SELinux modes by editing /etc/selinux/config. This is harmful because:

    Disabling SELinux using the SELINUX=disabled option in the /etc/selinux/config results in a process in which the kernel boots with SELinux enabled and switch to disabled mode later in the boot process. Because memory leaks and race conditions causing kernel panics can occur, prefer disabling SELinux by adding the selinux=0 parameter to the kernel command line as described in Changing SELinux modes at boot time.

  • Altogether the whole doc should be just lifted from Red Hat's SELInux Guide for RHEL8; the original quick-doc is based on the same content from RHEL7. (Note that as I'm writing this, the above problem isn't fixed in the RHEL8 guide yet, but the updated version should appear online sometime soon.)

  • Having a table of contents at the top would also be nice. (Just put :toc: right below the first heading, with no empty lines between.)

  • The page sources are split into multiple files for no good reason; we should make sure none of the sources are used anywhere else, and if that's true, then we should merge them all into one page.

  • Also consider grabbing the "Troubleshooting problems related to SELinux" chapter from the link above and making it into another quick-doc.

Just a note that I have already published the fixed chapter in the RHEL 8 Using SELinux title:
https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/using_selinux/index#Enabling_and_Disabling_SELinux-Disabling_SELinux_changing-selinux-states-and-modes

I have some minor changes for Chapter 3 Configuring SELinux for applications and services with non-standard configurations and Chapter 4 Troubleshooting problems related to SELinux still on my TODO list (especially using a different markup for commands entered by users and outputs)

I would Like to take this task as well!

Thanks, assigned to you now :+1:

Metadata Update from @ankursinha:
- Issue assigned to mmccabe4

2 years ago

Good evening,

Sorry it has taken me some time to get to this. I am having trouble this is
the first time I've worked with the files for this task, which are posted
in Asciidoc links. Is there a good documentation reference or
explanation on how I can do that to begin working on this document?

On Tue, Feb 1, 2022 at 4:26 AM Ankur Sinha pagure@pagure.io wrote:

ankursinha added a new comment to an issue you are following:
Thanks, assigned to you now :+1:

To reply, visit the link below or just reply to this email
https://pagure.io/fedora-docs/quick-docs/issue/207

Good evening,

Sorry it has taken me some time to get to this. I am having trouble this is
the first time I've worked with the files for this task, which are posted
in Asciidoc links. Is there a good documentation reference or
explanation on how I can do that to begin working on this document?

Hello,

Do you mean resources on SELinux, or resources on the documentation writing bits?

There's information here on the latter:

https://docs.fedoraproject.org/en-US/fedora-docs/

Oh I'm sorry, not that. When I edited this in my fork, the document is in
.adoc sections that I have not been able to fine files for or work with.

On Thu, Feb 10, 2022, 3:04 AM Ankur Sinha pagure@pagure.io wrote:

ankursinha added a new comment to an issue you are following:
``

Good evening,

Sorry it has taken me some time to get to this. I am having trouble this
is
the first time I've worked with the files for this task, which are posted
in Asciidoc links. Is there a good documentation reference or
explanation on how I can do that to begin working on this document?

Hello,

Do you mean resources on SELinux, or resources on the documentation
writing bits?

There's information here on the latter:

https://docs.fedoraproject.org/en-US/fedora-docs/

``

To reply, visit the link below or just reply to this email
https://pagure.io/fedora-docs/quick-docs/issue/207

"Also consider grabbing the "Troubleshooting problems related to SELinux" chapter from the link above and making it into another quick-doc."

I went ahead and did this as well. Are you able to advise where we would like this document sent to be added? Here is my copy ready to move over to pagure.

https://github.com/matmccabe/Fedora-Documents/blob/main/troubleshooting-problems-related-to-SELinux.adoc

We seem to have this page already, so maybe best to update it with all the info it is missing?

https://docs.fedoraproject.org/en-US/quick-docs/troubleshooting_selinux/

Could we put all ..."needs review" issue with 'good first issue' to EasyFix?

I guess we could, although, not all reviews maybe easy and so appropriate for newcomers? I have, in the past, e-mailed the devel list asking specialists to please help with reviewing docs/updates. Maybe we try to do that more regularly?

ok, I'm creating a QuickDocs boards for reviewers to track progress.

Metadata Update from @hankuoffroad:
- Issue untagged with: good first issue

a year ago

Log in to comment on this ticket.

Metadata
Boards 1
QuickDocs Boards Status: Backlog