-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some placeholder docs for building instructions and platform arch…
…itecture.
- Loading branch information
1 parent
68b384c
commit 69c7394
Showing
3 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Build Instructions | ||
================== | ||
|
||
... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Platform Architecture | ||
===================== | ||
|
||
... |