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

Add some guides #237

Merged
merged 6 commits into from
May 27, 2021
Merged

Add some guides #237

merged 6 commits into from
May 27, 2021

Conversation

felixfontein
Copy link
Contributor

SUMMARY

Using ansible-community/antsibull#255, adds two guides that describe how to create self-signed certificates, and how to set up and use an ownca.

You can see the result of this PR here: https://ansible.fontein.de/collections/community/crypto/#scenario-guides (assuming that the antsibull PR is merged)

Fixes #226.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

scenario guides

@felixfontein felixfontein mentioned this pull request May 24, 2021
@felixfontein felixfontein changed the title [WIP] Add some guides Add some guides May 26, 2021
@felixfontein
Copy link
Contributor Author

Since ansible-community/antsibull#255 has been merged, this is no longer a WIP 🎉

Copy link
Collaborator

@Ajpantuso Ajpantuso left a comment

Choose a reason for hiding this comment

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

LGTM.

On a side note I see sanity ran these through rstcheck, but are there any content guidelines for scenario guides? (To keep submitters and reviewers on the same page)

@felixfontein
Copy link
Contributor Author

Not really, this is still too new ;-) Well, there's antsibull-lint which should pass on the files. (I'll add that to CI soon.) (It checks whether the labels have the correct form, and also runs rstcheck.)

@felixfontein
Copy link
Contributor Author

The check successfully failed with:

00:16 Test "extra-docs" failed with the following 1 errors:
00:16 ./docs/docsite/rst/guide_selfsigned.rst:1:0: Label "ansible_collecions.community.crypto.docsite.guide_selfsigned" does not start with expected prefix "ansible_collections.community.crypto.docsite."

@felixfontein felixfontein merged commit 117438c into ansible-collections:main May 27, 2021
@felixfontein felixfontein deleted the guides branch May 27, 2021 20:59
@felixfontein
Copy link
Contributor Author

@Ajpantuso thanks for reviewing the docs :)

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.

x509_certificate: Unable to load certificate
2 participants