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

Improve documentation for SSL certificates #836

Open
bhrutledge opened this issue Nov 23, 2021 · 2 comments
Open

Improve documentation for SSL certificates #836

bhrutledge opened this issue Nov 23, 2021 · 2 comments

Comments

@bhrutledge
Copy link
Contributor

Following up on #835 (and related issues linked with), it seems like Twine's docs could be more helpful on how to use the --cert and --client-cert options, maybe as a new sub-section under Configuration. I think it'd also be nice indicate common gotchas, esp. related to environment configuration.

I'm out of my depth here, so suggestions welcome.

@sigmavirus24
Copy link
Member

I thought we had this in an older version of the docs and it was eliminated for "simplicity" when we switched themes and did other work to the docs. It was deemed useless back then if I remember correctly. Why is it suddenly useful now? Why do we expect people who don't search other resources in good faith to find it in the docs?

I think it'd also be nice indicate common gotchas, esp. related to environment configuration.

This sounds orthogonal and vague. How is this related to SSL certificates? What parts of the issue linked do you think relates to environment configuration?

@bhrutledge
Copy link
Contributor Author

I thought we had this in an older version of the docs and it was eliminated for "simplicity" when we switched themes and did other work to the docs. It was deemed useless back then if I remember correctly.

I have no recollection of that, and nothing is jumping out at me from the commit history. Can you find it?

Why do we expect people who don't search other resources in good faith to find it in the docs?

I hesitate to make assumptions about the steps that someone took prior to opening an issue. That said, opening an issue when encountering a confusing error seems reasonable, esp. for newcomers who might not be familiar with other support resources. I wouldn't expect folks to find it in Twine's docs (though I suspect some would), but I think it would be nice to have a quick "canonical" reference that's tailored to Twine's usage that maintainers could link to before closing the issue. It seems like there's a recent example of this re: proxy support in #814.

I'd write this myself, but as I've said, I'm out of my depth, because this is not a need for me, so I would need guidance on setting up a test environment.

How is this related to SSL certificates? What parts of the issue linked do you think relates to environment configuration?

I think this stems from my lack of familiarity. I used the word "environment" to encompass system/OS/network configuration, which is where I mentally bucket SSL certificate issues.

@bhrutledge bhrutledge changed the title Improve documentation for SSL certificaties Improve documentation for SSL certificates Nov 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants