docs icon indicating copy to clipboard operation
docs copied to clipboard

Update SMIME instructions for Linux/WSL2

Open N6UDP opened this issue 1 year ago • 5 comments

Why:

Closes: https://github.com/github/smimesign/issues/30 https://github.com/github/smimesign/issues/45

What's being changed (if available, include any code snippets, screenshots, or gifs):

Adding information for GPGSM on Linux and a note for both Windows and Linux about how to configure it on WSL2.

Check off the following:

  • [ ] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [ ] For content changes, I have completed the self-review checklist.

N6UDP avatar Feb 06 '24 01:02 N6UDP

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Feb 06 '24 01:02 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.11 3.10 3.9 3.8

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server

github-actions[bot] avatar Feb 06 '24 01:02 github-actions[bot]

@N6UDP Thanks for opening a PR! ✨

It looks like this is still a draft. Could you ping me when this is ready? Then, I'll get it up for review ⚡

nguyenalex836 avatar Feb 06 '24 16:02 nguyenalex836

@nguyenalex836 this should be good to go now.

N6UDP avatar Feb 10 '24 08:02 N6UDP

@N6UDP Awesome, thanks for letting me know! This has been triaged for review ✨

nguyenalex836 avatar Feb 12 '24 16:02 nguyenalex836

Hey @N6UDP thank you for the contribution. We checked in with our engineering team on this and GitHub doesn't officially support gpgsm. As such, we won't add documentation to our public docs for this use case. I'll go ahead and close this PR.

jc-clark avatar Mar 06 '24 22:03 jc-clark

@jc-clark even we don't want to add docs related to gpgsm you all should clarify the existing docs as they currently imply that smimesign is supported on linux which it is not.

N6UDP avatar Mar 14 '24 17:03 N6UDP

I see what you're saying here, @N6UDP thank you for the feedback. I can work with our team on the best follow up for that.

jc-clark avatar Mar 14 '24 21:03 jc-clark

@N6UDP We had a chance to chat about this and you're right that the docs currently imply that smimesign is supported on linux.

So we should fix that.

For this, we should make sure the x.509 information only shows up for the Mac and Windows versions of this doc and doesn't show up for Linux.

We can do that by replacing line 123 with the following:

{% windows %}

{% data reusables.gpg.x-509-key %}

{% endwindows %}

{% mac %}

{% data reusables.gpg.x-509-key %}

{% endmac %}

You or anyone else is welcome to open a new PR suggesting these changes.

jc-clark avatar Mar 28 '24 22:03 jc-clark