Butler Auth is an open source project, using the MIT license.
This means that all source code, documentation etc is available as-is, at no cost.
It however also means that anyone interested can - and is encouraged to - contribute to the project!
We use Hugo to format and generate this documentation site and the Docsy theme for styling and site structure.
Hugo is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.
All submissions, including submissions by project members, require review.
We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
Security/DisclosureIf you discover a serious bug with Butler Auth that may pose a security problem, please disclose it confidentially to email@example.com first, so that it can be assessed and hopefully fixed prior to being exploited. Please do not raise GitHub issues for security-related doubts or problems.
We use GitHub’s discussion boards to discuss ideas, features, issues and everything else relating to Butler Auth.
Contributing to Butler Auth and this documentation site
Butler Auth itself lives in https://github.com/ptarmiganlabs/butler-auth.
The doc site lives in https://github.com/ptarmiganlabs/butler-auth-docs.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
Test your changes
As obvious as it might sound: Please test your proposed changes properly before submitting pull requests.
Creating an issue
If you’ve found a problem - or have a feature suggestion - with Butler Auth or this documentation site, but you’re not sure how to fix it yourself, please create an issue in the Butler Auth or Butler Auth docs repos. You can also create an issue about a specific doc page by clicking the Create project issue button in the top right hand corner of the page.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.