diff --git a/docs/Introduction.md b/docs/Introduction.md index 4289ee7..d6072aa 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -6,47 +6,3 @@ This workshop will focus on using Studio to write `OpenAPI` files, models (schem ### 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/Training-Environment.md b/docs/sections/Training-Environment.md new file mode 100644 index 0000000..7d5b80c --- /dev/null +++ b/docs/sections/Training-Environment.md @@ -0,0 +1,46 @@ +# 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)