#40 Add external documentation
Merged 6 years ago by jhrozek. Opened 6 years ago by jhrozek.
SSSD/ jhrozek/docs external  into  master

file added
+32
@@ -0,0 +1,32 @@ 

+ External documentation about SSSD

+ =================================

+ 

+ Red Hat documentation

+ ---------------------

+ 

+ Red Hat maintains documentation about SSSD and Red Hat IDM. While the documentation can

+ be Red Hat specific as far as commands like package installation or configuration file

+ location go, it is still a very good source of information regardless of the distribution

+ you are running.

+ 

+  * The `System-level authentication guide <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/System-Level_Authentication_Guide/identity-auth-stores.html>`_

+    describes how SSSD works and how to configure it

+ 

+  * The `Windows integration guide <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Windows_Integration_Guide/index.html>`_

+    documents how to either join an SSSD client to an AD domain or integrate an Red Hat IDM domain with an AD forest

+ 

+  * The `Linux domain identity, authentication, and policy guide <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/index.html>`_

+    is aimed at documenting the Red Hat IDM server, but still might be useful to many users of SSSD.

+ 

+ 

+ Community documentation

+ -----------------------

+ 

+ This is a collection of documentation contributed by our community. Please note

+ that the SSSD team does not maintain this documentation.

+ 

+  * `Troubleshooting Active Directory and SSSD With Packet Captures <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/index.html>`_

+ 

+    * This document illustrates and documents network traffic between an SSSD

+      client running with the LDAP provider and an Active Directory server,

+      including use-cases such as invalid CA certificate.

file modified
+9
@@ -25,6 +25,15 @@ 

  

     newcomers/index.rst

     users/index.rst

+ 

+ .. toctree::

+    :maxdepth: 3

+ 

+    external/index.rst

+ 

+ .. toctree::

+    :maxdepth: 2

+ 

     developers/index.rst

  

  .. toctree::

adds a page with external documentation. So far there is only one link recently sent to sssd-users about a cloudshark documentation, but we should be adding more over time.

https://pagure.io/SSSD/docs/issue/31 says we do want that :-)

But I would put those links into another top-level section so they are more visible (or at least change how the external page is rendered), because more users will be interested in the RHEL documentation than the community-supplied docs.

rebased

6 years ago

OK, new version pushed.

My spell checker in vim complains about "config" it probably expects "configuration".

Otherwise LGTM

BTW I can see Red Hat IDM, IDM domain and IDM server. I am not sure what is an official name in RHEL but it would be good to use it consistently :-)

well, IDM domain and IDM server were used on purpose but the new version always uses "Red Hat IDM" in full.

rebased

6 years ago

Thank you very much you for fixing nitpicks :-)

ACK

Pull-Request has been merged by jhrozek

6 years ago
Metadata