Compare commits

..

8 Commits

Author SHA1 Message Date
Marc MacLeod
7f7b09a258 added working with files 2018-01-19 15:28:14 -06:00
Marc MacLeod
3e5172059d Update linking recommendation.
This method is more standard, and works out of the box with platforms like Github.
2018-01-19 12:23:21 -06:00
Marc MacLeod
f6eb587109 Does github only understand relative links? 2018-01-19 12:21:42 -06:00
Marc MacLeod
00699e029d Add link test. 2018-01-19 12:20:48 -06:00
Marc MacLeod
5335106e47 add initial table of contents 2018-01-19 12:19:53 -06:00
Marc MacLeod
f3615192bd Add Prism articles. 2018-01-19 11:58:42 -06:00
Marc MacLeod
07fda9a231 Add note about workflow. 2018-01-19 11:58:18 -06:00
Marc MacLeod
cc2ae98ebc Add initial batch of articles and templates. 2018-01-19 11:50:10 -06:00
42 changed files with 220 additions and 4 deletions

View File

@@ -2,17 +2,23 @@
The time is nigh!
All work should be done in the develop branch.
## Workflow
* All work should be done in a branch off of develop, and submitted via a PR upon completion.
## Templates
TODO
## Articles
TODO
## Assets
Assets (like images) should be placed in the assets/images folder.
JPEG, PNG, and GIF image formats are supported. Images can be included in markdown by using the path to the image.
JPEG, PNG, and GIF image formats are supported. Images can be included in markdown by using the relative path to the image.
For example:
@@ -21,7 +27,7 @@ For example:
# Organization Overview
![my image](./assets/images/my-image.jpg)
![my image](../../assets/images/my-image.jpg)
```
## Linking
@@ -35,5 +41,5 @@ For example:
# Organization Overview
A link to [Projects Overview](./articles/projects/overview.md).
A link to [Projects Overview](../projects/overview.md).
```

147
TOC.md Normal file
View File

@@ -0,0 +1,147 @@
* Platform
* Getting Started
* [What is Stoplight?](./articles/getting-started/what-is-stoplight.md)
* Getting started for new users
* Getting started for organization owners
* Onboard your organization to Stoplight (example: https://get.slack.help/hc/en-us/articles/115004378828-Onboard-your-company-to-Slack-#use-case-1-1)
* Account Basics
* Sign In to Stoplight
* Edit Your Profile
* Manage Your Password
* Change your Username
* Change your Email Address
* Sign out of Stoplight
* Deactivate your Stoplight Account
* Working with Todos
* Billing
* Plan Overview
* Invoices
* Cancel Your Account
* Discounts for Nonprofits/Educational Institutions
* Migrating from Stoplight Classic
* Overview
* Migrating Workspaces
* Migrating Published Documentation
* Migrating Billing
* Projects
* Creating a Project
* Inviting People & Teams to Projects
* Changing People & Team Project Roles
* Making Your Project Private/Public
* Organizations
* Create an Organization
* Invite People to Organization
* Remove People from Your Organization
* Member Roles and Permissions
* Customize your Organization
* Transfer Primary Ownership
* Delete an Organization
* Teams
* Create a Team
* Add People to a Team
* Remove People from a Team
* Member Roles and Permissions
* Customize a Team
* Transfer Primary Ownership
* Delete a Team
* Desktop App
* Overview (Differences between the web and desktop apps)
* Custom Hosts and Proxies
* Department Playbooks
* Stoplight for software developers
* Stoplight for QA testers
* Stoplight for technical writers
* Stoplight for product managers
* FAQs
* Editor
* Basics
* Working with files
* Switching between visual and code views
* Viewing history of changes
* File validation
* Working with environments
* Editor configuration
* Issues
* Creating Issues
* Replying to Issues
* Closing Issues
* Attaching issues to files
* @Mention People (link to todos article)
* Modeling APIs with OpenAPI (Swagger 2)
* Introduction (what is modeling and OAS)
* Building up an API Library
* Using the CRUD builder
* API operations
* API models
* Security schemes
* Shared parameters and responses
* Referencing another API spec
* Sending HTTP requests to your API
* Validating your API Spec
* Modeling Objects with JSON Schema
* Introduction
* Modeling open-ended objects (patternProperties)
* Modeling polymorphic objects (anyOf, oneOf)
* Using object inheritance (allOf)
* Adding validations
* Reducing duplication with $refs
* Generating schemas from examples
* Testing with Scenarios
* Introduction
* Understanding the scenario specification
* Running your tests
* In Stoplight
* In the Terminal
* Triggering by URL
* Using Variables
* Overview
* Passing data between steps (Capturing)
* $$.env (Environment)
* $.ctx (Context)
* Sending HTTP Requests
* Overview
* Using assertions
* Authorization
* Basic Authentication
* OAuth 2
* OAuth 1
* AWS Signature Auth
* Scripting
* Overview
* Before / After Scripts
* Script Step Type
* Referencing Other Scenarios
* Overview
* Using $.ctx with references
* Leveraging OpenAPI (Swagger 2)
* Overview
* Contract testing
* Generating tests from API specs
* Using coverage reports
* Integrating in Continuous Integration
* Circle CI
* Jenkins
* Travis
* Documenting with Hubs
* Introduction
* Routing
* Managing the Header & Footer
* Pages
* Subpages
* Blocks
* Overview
* Text
* ...
* Referencing / Embedding Other Data Sources
* Overview
* OpenAPI Specifications
* Markdown
* Theming
* Publishing
* Overview
* ...
* Running Servers with Prism
* Introduction
* Mock Servers
* Validation Servers
* Record / Replay Servers

View File

@@ -0,0 +1,15 @@
# Authenticating to Stoplight
## Registering
### With Email
### With Github
## Logging In
### With Email
### With Github
## Logging Out

View File

View File

View File

View File

@@ -0,0 +1 @@
# How Todos Work

View File

View File

View File

View File

View File

View File

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1 @@
# What is Stoplight?

View File

View File

View File

View File

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,13 @@
# Managing Organization Teams
## Creating a Team
## Adding People to a Team
## Removing People from a Team
## Member Roles
## Transferring Primary Ownership
## Deleting a Team

View File

@@ -0,0 +1,3 @@
# Stoplight Organizations
Testing a link to [projects](../projects/overview.md).

View File

View File

View File

View File

View File

View File

View File

View File

View File

@@ -0,0 +1 @@

View File

View File

@@ -0,0 +1,7 @@
# Project Collaboration
## Roles
## Inviting People & Teams to Projects
## Changing People & Team Project Roles

View File

View File

@@ -0,0 +1 @@
## Making Your Project Private/Public

0
templates/persona.md Normal file
View File

17
templates/short-form.md Normal file
View File

@@ -0,0 +1,17 @@
# Title
![image]()
## What
* one
* two
## Who
* [developer, manager]
## How
1. do this
2. do that

0
templates/tutorial.md Normal file
View File