Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.35 KB

File metadata and controls

43 lines (29 loc) · 1.35 KB

go-openapi/doc-site

Shared documentation for the go-openapi organization.

This repository is the single source of truth for common project documentation: contributing guidelines, coding style, security policy, licensing, and code of conduct.

Published site

https://go-openapi.github.io/doc-site/

What's here

Document Description
Contributing How to contribute to go-openapi projects
Coding Style Linting and code quality stance
Code of Conduct Contributor Covenant
DCO Developer Certificate of Origin
Security Vulnerability reporting policy
License Apache-2.0

Local development

cd hack/doc-site/hugo
go run gendoc.go
# Visit http://localhost:1313/doc-site/

Requires Hugo and the Relearn theme extracted at hack/doc-site/hugo/themes/hugo-relearn/.

Linking from other repositories

Other go-openapi projects can link to these shared docs instead of duplicating them:

See the [contributing guidelines](https://go-openapi.github.io/doc-site/contributing/contributing).

License

Apache-2.0