Skip to content

Improve TLS documentation #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 5, 2020
Merged

Improve TLS documentation #339

merged 1 commit into from
Jun 5, 2020

Conversation

tiran
Copy link
Member

@tiran tiran commented May 30, 2020

See: #55
Signed-off-by: Christian Heimes cheimes@redhat.com

@tiran tiran added the doc label May 30, 2020
@tiran tiran added this to the 3.3 milestone May 30, 2020
@codecov
Copy link

codecov bot commented May 30, 2020 •
edited
Loading

Codecov Report

Merging #339 into master will increase coverage by 0.35%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #339      +/-   ##
==========================================
+ Coverage   71.03%   71.38%   +0.35%     
==========================================
  Files          49       49              
  Lines        4833     4837       +4     
  Branches      808      808              
==========================================
+ Hits         3433     3453      +20     
+ Misses       1066     1050      -16     
  Partials      334      334
Impacted Files Coverage Δ
Lib/ldap/constants.py 100.00% <ø> (ø)
Modules/constants_generated.h 97.92% <ø> (ø)
Lib/ldap/cidict.py 100.00% <0.00%> (+30.76%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f8f10a9...e3d82d6. Read the comment docs.

encukou
encukou reviewed Jun 5, 2020
View reviewed changes
Copy link
Member

@encukou encukou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As expected, TLS docs are alphabet soup: TLS, CA, CRL, PEM, BER/DER
It would be nice to link to some definitions, or at least expand the abbreviations. Do you know of a place these could link to? Or are the abbreviations the best we can do?

@tiran @encukou
Improve TLS documentation
e3d82d6 
See: python-ldap#55
Signed-off-by: Christian Heimes <cheimes@redhat.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@tiran
Copy link
Member Author

tiran commented Jun 5, 2020

As expected, TLS docs are alphabet soup: TLS, CA, CRL, PEM, BER/DER
It would be nice to link to some definitions, or at least expand the abbreviations. Do you know of a place these could link to? Or are the abbreviations the best we can do?

I have sorted the attributes by topic and rephrased some of the words (e.g. ASN.1 structure instead of DER/BER and spelled out certificate revocation list).

@encukou
Copy link
Member

encukou commented Jun 5, 2020

Thank you!

encukou
encukou approved these changes Jun 5, 2020
View reviewed changes
Copy link
Member

@encukou encukou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason, Travis CI is not reporting results. But the build for e3d82d6 passed: https://travis-ci.org/github/python-ldap/python-ldap/builds/695071320

@encukou encukou merged commit c803bfc into python-ldap:master Jun 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@encukou encukou encukou approved these changes

Assignees
No one assigned
Labels
doc
Projects
None yet
Milestone
3.3
Development

Successfully merging this pull request may close these issues.
2 participants
@tiran @encukou