Skip to content

Commit

Permalink
Added 'Cookbook' for practical development details
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardBruskiewich committed Jul 26, 2022
1 parent 8b85cf5 commit f7a3852
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
30 changes: 30 additions & 0 deletions docs/guide-for-developers/cookbook.md
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/guide-for-developers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Guide for Developers

* [Quick Start](quickstart.md)
* [Developer Cookbook](cookbook.md)
* [Tutorials](tutorials/index.md)
* [The Full Monty...](details.md)

Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f7a3852

Please sign in to comment.