From f7a3852e19a1cd2ef9a4f71472cc5ddbab264aff Mon Sep 17 00:00:00 2001 From: richardbruskiewich Date: Tue, 26 Jul 2022 11:44:32 -0700 Subject: [PATCH] Added 'Cookbook' for practical development details --- docs/guide-for-developers/cookbook.md | 30 +++++++++++++++++++++++++++ docs/guide-for-developers/index.md | 1 + mkdocs.yml | 3 ++- 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/guide-for-developers/cookbook.md diff --git a/docs/guide-for-developers/cookbook.md b/docs/guide-for-developers/cookbook.md new file mode 100644 index 00000000..8871a01c --- /dev/null +++ b/docs/guide-for-developers/cookbook.md @@ -0,0 +1,30 @@ +# Developer Cookbook (Richard, Tim, Chris B) + +1. Project Management + 1. Project Management in Translator (Chris B) + 1. Project milestones + 2. Github in Translator + 1. Setting up repositories + 1. Role of NCATSTranslator, and other related specialized Git Organizations + 2. User Groups + 3. Access Policies + 2. Forking code + 3. Issue tracking + 4. How to submit a PR - Richard + 5. Publishing releases + 6. Publishing modules (pypi) +2. Coding process - Tim, Chris B + 1. Test Driven development + 2. Documentation Requirements + 1. Licensing +3. Describe how to test, deploy & version artifacts - Tim, Chris B, Mark W. + 1. Versioning artifacts + 2. Component registration: Translator Smart API Registry + 1. SmartAPI translator extension metadata + 3. Deployment environments: + 1. x-maturity: dev, prod, etc. + 4. Continuous Integration Dev Ops + 5. Packaging + 1. Docker + 6. Deployment Process + 1. ITRB diff --git a/docs/guide-for-developers/index.md b/docs/guide-for-developers/index.md index 10d8f01f..613046a0 100644 --- a/docs/guide-for-developers/index.md +++ b/docs/guide-for-developers/index.md @@ -3,6 +3,7 @@ # Guide for Developers * [Quick Start](quickstart.md) +* [Developer Cookbook](cookbook.md) * [Tutorials](tutorials/index.md) * [The Full Monty...](details.md) diff --git a/mkdocs.yml b/mkdocs.yml index 2fa314ec..b83c12b1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,9 +18,10 @@ nav: - Introduction: architecture/sri.md - Biolink Model: architecture/biolink_model.md - Evidence, Provenance & Confidence Metadata: architecture/epc.md - - 'User Guide': + - Developer Guide: - Introduction: guide-for-developers/index.md - Quick Start: guide-for-developers/quickstart.md + - Cookbook: guide-for-developers/cookbook.md - Tutorials: - Overview: guide-for-developers/tutorials/index.md - The Full Monty...: guide-for-developers/details.md