コントリビューション¶

コントリビューションはプルリクエストの形でより歓迎されます。

何か間違って見える場合は、いつでも問題 (issues) をオープンできます。

CI プロセス中に、多数の Linter が実行されることに注意してください :

yml ファイルの正確性を保証するため、yaml linting ルールをチェックすることをお勧めします
ドキュメンテーション・スタイルの一貫性を保つために、MD の linting ルールに従うことをお勧めします。

リポジトリへのプルリクエスト (PR) を作成すると、PR でのコンプライアンス検証の結果を確認することができます。CI プロセスが正常に終了した場合にのみマージが可能です。

新しいレシピのための重要事項¶

レシピの使い方とそれが機能するためにはどのようなものを設定しなければならないかについての説明と一緒に README.md を追加してください
どのサービスがステートフル でどれが ステートレス であるかを説明します
FIWARE Lab でそのまま使用できる実用的なデフォルト値をレシピに提供します。できるだけ多くのデフォルトを使用するので、最初のテスト展開の前にユーザはほとんど、またはまったく構成を必要としません
レシピを (フォルダ構造を尊重しながら)　次のカテゴリに従って整理してください

Portainer レシピへの貢献¶

SmartDSK レシピは、このガイドの後にコマンドライン・ツールを使用するか、または、 Portainer テンプレートを使用してデプロイ可能であることを目指しています。

Portainer テンプレート・ファイルのドキュメントは、Stack テンプレート定義フォーマットで文書化されています。

しかし、json ファイルは人間が編集しやすいわけではないので、このプロジェクトではテンプレートを portainer-template.yaml ファイルに書き込む必要があります。変更をコミットする前に、portainer/templates.json ファイルを更新するために、プロジェクトのルート・ディレクトリから make を実行してください。次に、 portainer-template.yaml と portainer/templates.json ファイルを一緒に追加してコミットします。

ドキュメンテーション¶

今のところ、Github Pages に Mkdocs を配備しています。

また、別の docs フォルダを用意する代わりに、ドキュメントは README のすべてのサブ・フォルダの内容で構成されているため、ドキュメントを可能な限り、それぞれのレシピに近づけるようにしています。

索引の構造を変更したり、新しいページを追加したりする場合は、それに応じて mkdocs.yml を更新してください。

変更をローカルでプレビューすることができます。

# from the location of mkdocs.yml
$ mkdocs serve

すべての変更の後、次のコマンドを実行することを忘れないでください。

# from the location of mkdocs.yml
$ mkdocs gh-deploy