Skip to content

Commit

Permalink
Added images to docs/README.md (oam-dev#451)
Browse files Browse the repository at this point in the history
* Update README.md

* Create test

* Add files via upload

* Update README.md

* Delete test

* Add files via upload

* Update README.md

* Update README.md

* Update README.md
  • Loading branch information
macolso authored and hongchaodeng committed Nov 8, 2019
1 parent 8d20188 commit 6dc4f46
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,23 @@
## [Install Rudr](./setup/install.md)
Install the Rudr runtime and its dependencies.

## [Tutorial](./tutorials/deploy_and_update.md)
Deploy, inspect, and update a Rudr application and its individual components.

## Concepts
Welcome to [Rudr](./concepts/using_rudr.md) - the Kubernetes implementation of the [Open Application Model](https://github.com/oam-dev/spec) specification. Below is documentation about the main application model constructs: components (and their workloads), traits, and application configurations.

### [Using Rudr](./concepts/using_rudr.md)
Learn the basics of using Rudr.

### [Application Configuration](./concepts/application-configuration.md)
As an *application operator*, define how your overall application will be instantiated and configured.
### [Component Schematic](./concepts/component-schematic.md)
![component schematic comic](./images/componentcomic.PNG)
As a *developer*, define the functional units that may be instantiated as part of a larger distributed application and their respective [workloads](./concepts/workloads.md). Learn about component schematics [here](./concepts/component-schematic.md).

#### [Traits](./concepts/traits.md)
As an *application operator*, attach operational features to component workloads of your application.
### [Traits](./concepts/traits.md)
![trait schematic comic](./images/traitcomic.PNG)
As an *application operator*, attach operational features to component workloads of your application. Learn more about traits [here](./concepts/traits.md).

### [Component Schematic](./concepts/component-schematic.md)
As a *developer*, define the operational characteristics of your component of code.
### [Application Configuration](./concepts/application-configuration.md)
![app config schematic comic](./images/appconfigcomic.PNG)
As an *application operator*, define how your overall application will be instantiated and configured. Learn about application configurations [here](./concepts/application-configuration.md).

#### [Workloads](./concepts/workloads.md)
As a *developer*, designate the appropriate workload type to execute your component on the Rudr runtime.
## [Tutorial](./tutorials/deploy_and_update.md)
Lets put everything together and deploy, inspect, and update a Rudr application.

## How-To's

Expand All @@ -36,4 +34,4 @@ Using Helm/Kustomize tools to manage OAM yamls, you will find how they could coo
Tips and best practices for setting up existing Kubernetes applications to use Rudr.

## [FAQ](./faq.md)
Find answers to commonly asked questions about Rudr and the Open Application Model (OAM).
Find answers to commonly asked questions about Rudr and the Open Application Model (OAM).
Binary file added docs/images/appconfigcomic.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/componentcomic.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/traitcomic.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6dc4f46

Please sign in to comment.