Compare commits
8 Commits
master
...
working-wi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7f7b09a258 | ||
|
|
3e5172059d | ||
|
|
f6eb587109 | ||
|
|
00699e029d | ||
|
|
5335106e47 | ||
|
|
f3615192bd | ||
|
|
07fda9a231 | ||
|
|
cc2ae98ebc |
14
README.md
14
README.md
@@ -2,17 +2,23 @@
|
|||||||
|
|
||||||
The time is nigh!
|
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
|
## Templates
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
## Articles
|
## Articles
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
## Assets
|
## Assets
|
||||||
|
|
||||||
Assets (like images) should be placed in the assets/images folder.
|
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:
|
For example:
|
||||||
|
|
||||||
@@ -21,7 +27,7 @@ For example:
|
|||||||
|
|
||||||
# Organization Overview
|
# Organization Overview
|
||||||
|
|
||||||

|

|
||||||
```
|
```
|
||||||
|
|
||||||
## Linking
|
## Linking
|
||||||
@@ -35,5 +41,5 @@ For example:
|
|||||||
|
|
||||||
# Organization Overview
|
# Organization Overview
|
||||||
|
|
||||||
A link to [Projects Overview](./articles/projects/overview.md).
|
A link to [Projects Overview](../projects/overview.md).
|
||||||
```
|
```
|
||||||
|
|||||||
147
TOC.md
Normal file
147
TOC.md
Normal 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
|
||||||
15
articles/accounts/authentication.md
Normal file
15
articles/accounts/authentication.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Authenticating to Stoplight
|
||||||
|
|
||||||
|
## Registering
|
||||||
|
|
||||||
|
### With Email
|
||||||
|
|
||||||
|
### With Github
|
||||||
|
|
||||||
|
## Logging In
|
||||||
|
|
||||||
|
### With Email
|
||||||
|
|
||||||
|
### With Github
|
||||||
|
|
||||||
|
## Logging Out
|
||||||
0
articles/accounts/changing-your-email.md
Normal file
0
articles/accounts/changing-your-email.md
Normal file
0
articles/accounts/changing-your-username.md
Normal file
0
articles/accounts/changing-your-username.md
Normal file
0
articles/accounts/password-management.md
Normal file
0
articles/accounts/password-management.md
Normal file
0
articles/accounts/profile-management.md
Normal file
0
articles/accounts/profile-management.md
Normal file
1
articles/accounts/todos.md
Normal file
1
articles/accounts/todos.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# How Todos Work
|
||||||
0
articles/billing/canceling.md
Normal file
0
articles/billing/canceling.md
Normal file
0
articles/billing/discounts.md
Normal file
0
articles/billing/discounts.md
Normal file
0
articles/billing/invoices.md
Normal file
0
articles/billing/invoices.md
Normal file
0
articles/billing/overview.md
Normal file
0
articles/billing/overview.md
Normal file
0
articles/desktop/custom-proxies.md
Normal file
0
articles/desktop/custom-proxies.md
Normal file
0
articles/desktop/overview.md
Normal file
0
articles/desktop/overview.md
Normal file
1
articles/editor/working-with-files.md
Normal file
1
articles/editor/working-with-files.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
1
articles/getting-started/organization-onboarding.md
Normal file
1
articles/getting-started/organization-onboarding.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
1
articles/getting-started/stoplight-for-org-owners.md
Normal file
1
articles/getting-started/stoplight-for-org-owners.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
1
articles/getting-started/what-is-stoplight.md
Normal file
1
articles/getting-started/what-is-stoplight.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# What is Stoplight?
|
||||||
0
articles/migrating/api-docs.md
Normal file
0
articles/migrating/api-docs.md
Normal file
0
articles/migrating/billing.md
Normal file
0
articles/migrating/billing.md
Normal file
0
articles/migrating/overview.md
Normal file
0
articles/migrating/overview.md
Normal file
0
articles/migrating/workspaces.md
Normal file
0
articles/migrating/workspaces.md
Normal file
1
articles/organizations/managing-people.md
Normal file
1
articles/organizations/managing-people.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
13
articles/organizations/managing-teams.md
Normal file
13
articles/organizations/managing-teams.md
Normal 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
|
||||||
3
articles/organizations/overview.md
Normal file
3
articles/organizations/overview.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Stoplight Organizations
|
||||||
|
|
||||||
|
Testing a link to [projects](../projects/overview.md).
|
||||||
0
articles/organizations/roles.md
Normal file
0
articles/organizations/roles.md
Normal file
0
articles/organizations/transferring-ownership.md
Normal file
0
articles/organizations/transferring-ownership.md
Normal file
0
articles/playbooks/engineers.md
Normal file
0
articles/playbooks/engineers.md
Normal file
0
articles/playbooks/managers.md
Normal file
0
articles/playbooks/managers.md
Normal file
0
articles/playbooks/qa-testers.md
Normal file
0
articles/playbooks/qa-testers.md
Normal file
0
articles/playbooks/writers.md
Normal file
0
articles/playbooks/writers.md
Normal file
0
articles/prism/mocking.md
Normal file
0
articles/prism/mocking.md
Normal file
0
articles/prism/overview.md
Normal file
0
articles/prism/overview.md
Normal file
0
articles/prism/record-replay.md
Normal file
0
articles/prism/record-replay.md
Normal file
1
articles/prism/runtime.md
Normal file
1
articles/prism/runtime.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
0
articles/prism/validation.md
Normal file
0
articles/prism/validation.md
Normal file
7
articles/projects/collaboration.md
Normal file
7
articles/projects/collaboration.md
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# Project Collaboration
|
||||||
|
|
||||||
|
## Roles
|
||||||
|
|
||||||
|
## Inviting People & Teams to Projects
|
||||||
|
|
||||||
|
## Changing People & Team Project Roles
|
||||||
0
articles/projects/overview.md
Normal file
0
articles/projects/overview.md
Normal file
1
articles/projects/visibility.md
Normal file
1
articles/projects/visibility.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
## Making Your Project Private/Public
|
||||||
0
templates/persona.md
Normal file
0
templates/persona.md
Normal file
17
templates/short-form.md
Normal file
17
templates/short-form.md
Normal 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
0
templates/tutorial.md
Normal file
Reference in New Issue
Block a user