-
Notifications
You must be signed in to change notification settings - Fork 170
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.
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
Add Secure socket documentations #759
Conversation
This doesn't follow our usual structure. Should we move some of this content into architecture and configuration? |
@SeppoTakalo Please rearrange, so the description is at the beginning, and the examples come at the end. |
This page still needs to be arranged to match our standard template. |
I'll start to work on this within this sprint. |
What's the status of this? |
This PR is waiting on content rearrangement to match our other APIs. |
@AnotherButler I moved the generic design part under the "reference" book and created simpler |
I noticed that Doxygen have not parsed the TLSSocket classes, so I have fixed those now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work on this, @SeppoTakalo 👍 It looks great
Update: This PR is only waiting on the code dependency to make the Doxygen work. |
Complete initial copy edits.
Created separate pages for TLSSocket and DTLSSocket classes
Make minor edits, mostly for active voice and consistent tone across documents.
Make minor edits, mostly for active voice and consistent tone across docs.
Edit file for minor grammar and formatting nits.
@AnotherButler Code has now been merged. This PR can also be merged now. |
Can we add an example that showcases a Secure TLS socket connection? Also, would you consider adding a tutorial based on this content, which is really useful? |
@MarceloSalazar As long as the code is still up to date, I'm happy to convert the content into a new tutorial. However, that's out of scope of this PR and won't happen for code freeze. Could you please create a new task for that? |
@MarceloSalazar There is an example, embedded in the documentation. Just click the "View Program button" and it leads to the example. https://github.com/ARMmbed/mbed-os-examples-docs_only/blob/master/TLSSocket/main.cpp When documentation is rendered, this would be the "Import program" button. |
@AnotherButler no problem, I'm not expecting the content from the blog to land in docs for 5.11.0. @SeppoTakalo thanks for the link to the example. It looks relatively simple (not too many lines of code :)
On a separate note (also FYI @adbridge):
|
@MarceloSalazar As this is not an official mbed-os-example then it won't be updated in the same way we do for other examples for OOB. Onus will be on the example owner ie @SeppoTakalo to make sure this is ready and suitable. |
Is this ready to merge? |
Yes |
Add documentation about Secure Socket.
Class references cannot yet be added, because implementation PR just submitted in ARMmbed/mbed-os#8311
@AnotherButler please review.
This documentation has already been technically reviewed by @kjbracey-arm in external repository.