Skip to content

Commit

Permalink
Add some placeholder docs for building instructions and platform arch…
Browse files Browse the repository at this point in the history
…itecture.
  • Loading branch information
GrahamDumpleton committed Aug 14, 2023
1 parent 68b384c commit 69c7394
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
19 changes: 19 additions & 0 deletions developer-docs/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
Developer Documentation
=======================

The Educates project consists of the following Git repositories:

* Educates Training Platform - https://github.com/vmware-tanzu-labs/educates-training-platform
* Educates Packages Repository - https://github.com/vmware-tanzu-labs/educates-packages
* Educates User Documentation - https://github.com/vmware-tanzu-labs/educates-docs
* Educates GitHub Actions - https://github.com/vmware-tanzu-labs/educates-github-actions

Educates Training Platform (this repository), holds all source code for building and making releases of the core platform.

Educates Packages Repository holds the definitions used to generate the Carvel packages from which Educates can be installed using the Carvel ``kapp-controller`` operator.

Educates User Documentation holds the source files for user documentation hosted on https://docs.educates.dev/.

Educates GitHub Actions holds GitHub actions to assist in publishing workshops to GitHub container registry.

If wanting to contribute to Educates, you can build and deploy a local copy of Educates by following the [build instructions](build-instructions.md).

For details on the design of Educates and how it works check out notes on it's [platform architecture](platform-architecture.md).
4 changes: 4 additions & 0 deletions developer-docs/build-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Build Instructions
==================

...
4 changes: 4 additions & 0 deletions developer-docs/platform-architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Platform Architecture
=====================

...

0 comments on commit 69c7394

Please sign in to comment.