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 back descriptive content on cert issuing #1494

Merged
merged 1 commit into from Dec 20, 2023

Conversation

cmurphy
Copy link
Contributor

@cmurphy cmurphy commented Dec 13, 2023

As part of doc enhancements in ae4c766, the description in step 7 was removed. Although the final step is simple and the diagram and section header are clear, it is jarring for the final step to be inconsistent with the others by having no text body. It is moreover unfriendly to screen readers since there is no context for the diagram. This change adds the brief description back for the sake of readability.

Summary

Enhance the documentation readability by having a consistent flow from step to step.

Release Note

NONE

Documentation

n/a

As part of doc enhancements in ae4c766, the description in step 7 was
removed. Although the final step is simple and the diagram and section
header are clear, it is jarring for the final step to be inconsistent
with the others by having no text body. It is moreover unfriendly to
screen readers since there is no context for the diagram. This change
adds the brief description back for the sake of readability.

Signed-off-by: Colleen Murphy <colleenmurphy@google.com>
Copy link

codecov bot commented Dec 13, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a19a892) 57.58% compared to head (59726dd) 57.58%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1494   +/-   ##
=======================================
  Coverage   57.58%   57.58%           
=======================================
  Files          50       50           
  Lines        3112     3112           
=======================================
  Hits         1792     1792           
  Misses       1160     1160           
  Partials      160      160           

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

Copy link
Contributor

@haydentherapper haydentherapper left a comment

Choose a reason for hiding this comment

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

Sorry I missed this, thanks!

@haydentherapper haydentherapper merged commit 8b1c665 into sigstore:main Dec 20, 2023
13 checks passed
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.

None yet

2 participants