Do you want to contribute to Shipwright's documentation, or publish a blog post about Shipwright? You have come to the right place!
- Review the overall project contributor guide and code of conduct.
- Set up your computer to contribute content to the website. Review the "Getting Started" section in the README for details.
There are two main forms of content on the website - documentation and blog posts.
We use the Hugo framework to generate the website content, which supports
internationalization. At present we publish content only in English, located in the content/en
directory.
Documentation content can come in various forms, but is directly related to the features and
functionality of Shipwright's projects. This content is located in the content/en/docs directory.
API reference documentation - located in content/en/docs/ref - should not be edited by hand. This
content should only be generated by running the gen-api-docs Makefile target:
make gen-api-docsBlog post content should be located in the content/en/blog/posts directory.
Release notes may also be published in the content/en/blog/releases directory.