diff --git a/assets/images/account.png b/assets/images/account.png deleted file mode 100644 index 71e6a5a..0000000 Binary files a/assets/images/account.png and /dev/null differ diff --git a/assets/images/addModel.gif b/assets/images/addModel.gif deleted file mode 100644 index 88b31c4..0000000 Binary files a/assets/images/addModel.gif and /dev/null differ diff --git a/assets/images/addRefs.gif b/assets/images/addRefs.gif deleted file mode 100644 index f95eea9..0000000 Binary files a/assets/images/addRefs.gif and /dev/null differ diff --git a/assets/images/apis.png b/assets/images/apis.png deleted file mode 100644 index 17bdbf7..0000000 Binary files a/assets/images/apis.png and /dev/null differ diff --git a/assets/images/branches.gif b/assets/images/branches.gif deleted file mode 100644 index a085390..0000000 Binary files a/assets/images/branches.gif and /dev/null differ diff --git a/assets/images/device.png b/assets/images/device.png deleted file mode 100644 index bad7923..0000000 Binary files a/assets/images/device.png and /dev/null differ diff --git a/assets/images/docs.png b/assets/images/docs.png deleted file mode 100644 index e2a03d8..0000000 Binary files a/assets/images/docs.png and /dev/null differ diff --git a/assets/images/files.png b/assets/images/files.png deleted file mode 100644 index 2394ac9..0000000 Binary files a/assets/images/files.png and /dev/null differ diff --git a/assets/images/location.png b/assets/images/location.png deleted file mode 100644 index 95faba8..0000000 Binary files a/assets/images/location.png and /dev/null differ diff --git a/assets/images/logo.png b/assets/images/logo.png deleted file mode 100644 index 349ab05..0000000 Binary files a/assets/images/logo.png and /dev/null differ diff --git a/assets/images/modelProps.gif b/assets/images/modelProps.gif deleted file mode 100644 index 07f4cde..0000000 Binary files a/assets/images/modelProps.gif and /dev/null differ diff --git a/assets/images/newAPI.png b/assets/images/newAPI.png deleted file mode 100644 index 4233ffe..0000000 Binary files a/assets/images/newAPI.png and /dev/null differ diff --git a/assets/images/pull.png b/assets/images/pull.png deleted file mode 100644 index d13cb5c..0000000 Binary files a/assets/images/pull.png and /dev/null differ diff --git a/assets/images/push.gif b/assets/images/push.gif deleted file mode 100644 index 839ad79..0000000 Binary files a/assets/images/push.gif and /dev/null differ diff --git a/assets/images/ui.png b/assets/images/ui.png deleted file mode 100644 index 7f4da44..0000000 Binary files a/assets/images/ui.png and /dev/null differ diff --git a/assets/images/user.png b/assets/images/user.png deleted file mode 100644 index 9d5156c..0000000 Binary files a/assets/images/user.png and /dev/null differ diff --git a/docs/Create-an-API.md b/docs/Create-an-API.md deleted file mode 100644 index dbcbc22..0000000 --- a/docs/Create-an-API.md +++ /dev/null @@ -1,15 +0,0 @@ -# Create an API - -You will notice that your APIs tab is pretty empty besides a few model files we provided to you. Let's change that! - - -> ### Use the Starter Branch! ->*Make sure that you are using the right branch to complete the exercises.* - -Start by adding a new API by clicking on the blue plus `(+)` icon on the top left of the UI. - -Create an API called 'devices', using `OpenAPI v3` and `YAML` format. - -![newAPI](../assets/images/newAPI.png) - - diff --git a/docs/Introduction.md b/docs/Introduction.md deleted file mode 100644 index 6bb69da..0000000 --- a/docs/Introduction.md +++ /dev/null @@ -1,19 +0,0 @@ -# Introduction - -Welcome to the beginner lab for Stoplight Studio. - -![logo](../assets/images/logo.png) - -This workshop will focus on using Studio to write `OpenAPI` files, models (schemas) and markdown articles. We also cover adding `Spectral` and configuration files to provide a full understanding of Studio's functionality. - -This lab provides a `starter` branch which you will use to complete the exercises. It also contains a `final` branch that serves as a reference for what the end result will look like. - -To learn more about how branches work, checkout the next section called '**Training Environment**'. - - - -> ### Getting Started -> -> *Begin the lab by becoming familiar with the **Training Environment** and the **Stoplight Studio UI**.* -> ->*Then proceed to complete each subsequent section until you have produced a final project.* \ No newline at end of file diff --git a/docs/sections/1. Training-Environment.md b/docs/sections/1. Training-Environment.md deleted file mode 100644 index 7d5b80c..0000000 --- a/docs/sections/1. Training-Environment.md +++ /dev/null @@ -1,46 +0,0 @@ -# Training Environment - -To complete this workshop you need access to Stoplight Studio in your browser, provided by a [Stoplight workspace](https://stoplight.io/welcome/create) or you can download the [Studio application](https://stoplight.io/studio/) to your desktop or laptop. - -### Git - -Stoplight Studio is a powerful git client that allows users to leverage version control to power their API designs. This approach provides greater collaboration, reviews and gives your team full ownership of the source of truth for your design documents. - -As a result there are a few key features that you should be aware of: - -#### Branches - -Studio can checkout existing git branches and create new branches as you are working with your API designs and documentation. - -![branches](../../assets/images/branches.gif) - -#### Push - -Studio can push your changes to new or existing branches on your source control. You can also compare changes and add commit messages when you push a change. - -![push](../../assets/images/push.gif) - -#### Pull - -To get the latest update from your repository, click on the button called '*Pull latest from git repo*'. - -![pull](../../assets/images/pull.png) - -### Tabs - -Studio will also organize your repository into functional tabs to make your work easier. - -#### APIs -If you are focused on API design, the 'APIs' tab will only display OpenAPI and model files. - -![apis](../../assets/images/apis.png) - -#### Docs -If you are writing behavioral documentation, the 'Docs' tab will display markdown files and other assets such as images. - -![docs](../../assets/images/docs.png) - -#### Files -The 'Files' tab will display all files and directories located in your repository in case you need them. - -![files](../../assets/images/files.png) diff --git a/docs/sections/2. Studio-UI.md b/docs/sections/2. Studio-UI.md deleted file mode 100644 index 8bfc1c0..0000000 --- a/docs/sections/2. Studio-UI.md +++ /dev/null @@ -1,12 +0,0 @@ -# Studio UI - -![UI](../../assets/images/ui.png) - -1. **Project Actions:** Contains actions to help you add new assets to your project, such as APIs, models, articles, etc. -2. **Project Trees:** The project sidebar tree tabs provide different views into your project. Switch between a view of API related assets, docs, and all of the files/folders in your project. -3. **Primary Panel:** You can switch which mode is shown on the primary panel by clicking the mode selector in the top right. You can show the form editor, docs view, or code editor here. You can also click the expand button to go full screen with the panel. -4. **Secondary Panel:** The secondary panel allows you to view two different modes side by side. In this screenshot, we've configured Studio to show the form editor in the primary panel, and the code editor in the secondary panel. -5. **Settings & Login:** Most of Studio can be used offline & while logged out. A few features, such as git, require you to login. -6. **Git:** If the project you are working with is connected to a Git repository, you can quickly switch branches by clicking on these buttons. -7. **Crumbs:** These crumbs give you an at a glance look at where you are in your project. -8. **Spectral & Prism:** Click these buttons to open the validations and mocking panels. \ No newline at end of file diff --git a/docs/sections/Models.md b/docs/sections/Models.md deleted file mode 100644 index 7a4a924..0000000 --- a/docs/sections/Models.md +++ /dev/null @@ -1,46 +0,0 @@ -# Models - -## 1. Add JSON Models -Create stand alone `JSON` files for the following user, account and location models. This example gif demonstrates how to add a new model file. - -![add model](../../assets/images/addModel.gif) - - -> ### Use the Common scope & JSON format ->*That way your models will be created as independent *`JSON`* files rather than written inline in the *`OAS`* file.* - -### User -**Description**: *Users associated with a CloudHome account. Administrative priviledges are indicated to show which users can configure device management and which users can only interact with configured devices.* - -![user model](../../assets/images/user.png) - -### Account -**Description**: *Users can belong to multiple accounts on CloudHome's federated services. In other words users have a unique id that can interact or manage devices on more than one account or location.* - -![account model](../../assets/images/account.png) - -### Location -**Description**: *Device geolocation at most recent update. Users can optionally choose to turn off geolocation, however key features such as mapping will not be available.* - -![location model](../../assets/images/location.png) - - - - -> ### A thing to know... -> -> *If you wish to add descriptions or additional validation to your fields you can do so as demonstrated in the following example.* - -![model properties](../../assets/images/modelProps.gif) - -## 2. Add References to the New Models -Select the `device.v1.json` model and add references (`$ref`) to the new models you added in the previous step. This will create a complete representation of the schema used to manage devices. - -In other words, within the `device.v1.json` model, add references to the `user.v1.yaml`, `account.v1.yaml` and `location.v1.yaml` files. - -![devices](../../assets/images/device.png) - -The following example demonstrates how to add references (`$ref`) to a model: - -![add references](../../assets/images/addRefs.gif) -