Skip to content
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

docs: add text version of certificates tutorial #1073

Merged
merged 3 commits into from
Aug 20, 2024

Conversation

edibotopic
Copy link
Contributor

The ADSys documentation contains one tutorial currently.

It is only presented in video format, and generally there should be a text-based version of any tutorial that is included in our documentation.

This PR provides a text-based version of the video tutorial. It attempts to adhere closely to the video content while adding/subtracting as necessary for clarity.

Some minor rewording is also done to the main and tutorial index pages to improve clarity and consistency.

UDENG-3603

@edibotopic edibotopic changed the title docs: add text version of cert tutorial docs: add text version of certificates tutorial Aug 20, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.80%. Comparing base (f01a3ac) to head (1270c01).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1073   +/-   ##
=======================================
  Coverage   93.80%   93.80%           
=======================================
  Files          79       79           
  Lines        6881     6881           
=======================================
  Hits         6455     6455           
  Misses        416      416           
  Partials       10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@edibotopic edibotopic marked this pull request as ready for review August 20, 2024 12:45
@edibotopic edibotopic requested a review from a team as a code owner August 20, 2024 12:45
Copy link
Collaborator

@jibel jibel left a comment

Choose a reason for hiding this comment

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

Thanks for the transcription of the demo in a tutorial. Only request is to change the version of Ubuntu to the latest LTS

docs/tutorial/certificates-autoenrolment.md Outdated Show resolved Hide resolved
docs/tutorial/certificates-autoenrolment.md Outdated Show resolved Hide resolved
docs/.custom_wordlist.txt Outdated Show resolved Hide resolved
@edibotopic
Copy link
Contributor Author

thanks @jibel -- I was trying to maintain consistency with the video but I think it's better to update, as you suggest. Will do.

@edibotopic edibotopic force-pushed the docs-add-text-version-of-cert-tutorial branch from 15fb650 to 1270c01 Compare August 20, 2024 16:24
@edibotopic edibotopic requested a review from jibel August 20, 2024 16:34
Copy link
Collaborator

@jibel jibel left a comment

Choose a reason for hiding this comment

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

All good!

@edibotopic edibotopic merged commit 77cf3fb into main Aug 20, 2024
5 checks passed
@edibotopic edibotopic deleted the docs-add-text-version-of-cert-tutorial branch August 20, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants