Compare commits

...

27 Commits

Author SHA1 Message Date
Robert Wallach
60c121c770 Update oauth.md 2018-05-21 14:28:32 -05:00
Robert Wallach
d0a8f14db9 Update export-files.md 2018-05-15 12:18:53 -05:00
Robert Wallach
bfb46c1d65 Update managing-people.md 2018-05-09 16:00:43 -05:00
Robert Wallach
a443436712 Update managing-people.md 2018-05-09 16:00:15 -05:00
Robert Wallach
3372e8a77f Update roles.md 2018-05-09 15:55:44 -05:00
Robert Wallach
36d5c3900d Update permissions-overview.md 2018-05-09 15:53:49 -05:00
Robert Wallach
ab39e3ef9e Update ref-other-sources-hubs.md 2018-05-09 11:33:02 -05:00
Robert Wallach
bc2240e68b Add files via upload 2018-05-09 11:30:14 -05:00
Robert Wallach
0657e350e7 Delete hubs-power-page.gif 2018-05-09 11:29:50 -05:00
Robert Wallach
77c65e4ef0 Add files via upload 2018-05-09 11:28:44 -05:00
Robert Wallach
14d5fd54e4 Delete hubs-power-page.gif 2018-05-09 11:28:28 -05:00
Robert Wallach
dd34c085fe Add files via upload 2018-05-09 11:27:55 -05:00
Robert Wallach
9419eaad52 Add files via upload 2018-05-09 11:25:48 -05:00
Chris Lott
1a8ec8509f How to serve builds locally on your computer (#223)
* How to serve locally on your computer

* Update export-static-html.md
2018-05-08 12:34:21 -05:00
Robert Wallach
eb19be5dcf Create auth0-integration.md (#225)
* Create auth0-integration.md

* Update auth0-integration.md

* Update auth0-integration.md

* Update auth0-integration.md

* Update auth0-integration.md
2018-05-08 11:36:21 -05:00
Robert Wallach
c371ae875e Add files via upload 2018-05-08 11:16:59 -05:00
Robert Wallach
bbd855d939 Add files via upload 2018-05-08 11:08:26 -05:00
Robert Wallach
ebc6fdc7df Add files via upload 2018-05-07 16:59:53 -05:00
Robert Wallach
ededa22a3c Add files via upload 2018-05-07 16:50:13 -05:00
Robert Wallach
d2b5709aac Delete auth0-settings.png 2018-05-07 16:45:15 -05:00
Robert Wallach
e6201c8ff5 Delete auth0-dashboard.png 2018-05-07 16:45:04 -05:00
Robert Wallach
7d4ed2ef7c Delete application-name-single-page.png 2018-05-07 16:44:55 -05:00
Robert Wallach
7694b124a3 Delete hubs-authorization.png 2018-05-07 16:44:44 -05:00
Robert Wallach
e0c7489d30 Delete create-application.png 2018-05-07 16:44:30 -05:00
Robert Wallach
53f9710677 Delete callback-urls.png 2018-05-07 16:44:19 -05:00
Robert Wallach
226af863cc Add files via upload 2018-05-07 16:43:45 -05:00
Robert Wallach
39754e693a Create modeling-grouping-tagging.md (#221)
* Create grouping-tagging.md

* Update grouping-tagging.md

* Update grouping-tagging.md
2018-05-07 15:43:39 -05:00
19 changed files with 90 additions and 21 deletions

View File

@@ -6,7 +6,7 @@
You can export any files in Stoplight to use as you see fit. Exported files are served up in a unique domain in its raw format. Current exported file formats include:
### YAML
### JSON
- Documentation
- Modeling
- Testing

View File

@@ -2,7 +2,7 @@
## Organizations
| **Organization Actions** | **Reader** | **Creator** | **Administrator** | **Owner** |
| **Organization Actions** | **Reader** | **Contributor** | **Administrator** | **Owner** |
|---------------------------------|:----------:|:-----------:|:-----------------:|:---------:|
| Read Public Projects | X | X | X | X |
| View Organization Collaborators | | X | X | X |

View File

@@ -0,0 +1,48 @@
# Auth0 Integration
## What
Auth0 allows you to add a login form with user access management to your documentation.
## How
1. Create an account or login to [Auth0](https://auth0.com/)
2. Select **Applications** in the Auth0 menu
![Auth0 Dashboard](https://github.com/stoplightio/docs/blob/develop/assets/images/auth0-dashboard.png?raw=true)
3. Click **+ Create Application**
![Create Application](https://github.com/stoplightio/docs/blob/develop/assets/images/create-application.png?raw=true)
4. Input a **Name** for your application
![Create Application Details](https://github.com/stoplightio/docs/blob/develop/assets/images/application-create.png?raw=true)
5. Select **Regular Web Applications**
6. Click **Create**
7. Select **Application Settings**
![Auth0 Settings](https://github.com/stoplightio/docs/blob/develop/assets/images/auth0-new-settings.png?raw=true)
8. Copy the **Domain** and paste it in **Hosted Login Page**
9. Input a **?client=** at the end of the pasted **Domain** from above
10. Copy the **Client ID** and paste it after the **?client=** in **Hosted Login Page** from above
> Example Hosted Login Page: robertwallach.auth0.com?client=XwYWVMLp7rJOkJ6iU51MwJHm2w2AAfGl
11. Copy the **Client Secret** and paste it in **Client Secrets** in Hubs
![Hubs Authorizations](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-authorization.png?raw=true)
12. Copy the **Callback URL** generated by Hubs in **Authorizations** and paste it in **Allowed Callback URLs** in Auth0
> Make sure the callbacks start with https instead of http and that they match
![Allowed Callback URL](https://github.com/stoplightio/docs/blob/develop/assets/images/callback-urls.png?raw=true)
13. Select **Hosted Pages** in the Auth0 menu
> Make sure **Customize Login Page** is turned on
14. Click on **Build** to start the Publishing process
> To login to your Hub with Auth0, make sure you add users in the Auth0 Dashboard

View File

@@ -4,18 +4,25 @@
> Requires a Pro Docs plan
## What
If you would rather host your documentation outside of Stoplight's hosted servers, you can download a built version of your Hub. Downloading a build will produce a `.zip` containing all of the minified assets necessary to load your Hub. These assets will include HTML, JAvascript, CSS, and JSON files.
## What?
If you would rather host your documentation outside of Stoplight's hosted servers, you can download a built version of your Hub. Downloading a build will produce a `.zip` containing all of the minified assets necessary to load your Hub. These assets will include HTML, JavaScript, CSS, and JSON files. You will need an HTTP File Server in order to properly view and navigate your downloaded Hub. Any authorizations (Auth0, SAML, etc) you have added will not work, since they require a backend server.
## How to Download
## How to download
1. Click the **Publish** icon on the far left toolbar
2. Select or create a **domain**
3. Choose a **Hub** or **OAS** file to create a build from
4. Click the **Build** button to start the build process.
3. Choose a **Hub** or **OAS** file
4. Click the **Build** button to start the build process
> If this is your first build, it will also publish to your selected domain
> If this is your first build, it will also publish to your selected domain
5. Once your **Hub** has finished building, it will appear in the **Builds** section. Click the download icon to the right of the build
6. Unzip the downloaded `.zip` to view all of the assets. It will most likely be located in your Downloads folder
## How to serve locally on your computer (Mac)
1. Open Terminal and `cd` into the root of your build folder
2. Start your favorite file server (Ex. `python -m SimpleHTTPServer`)
3. Open a web browser and navigate to the file server's local url (Ex `http://localhost:3000`)
5. Once your **Hub** has finished building, it will appear in the **Builds** section. Click the download icon to the right of the build
---
**Related Articles**
- [Documentation with Hubs](/documentation/introduction)

View File

@@ -1,10 +1,10 @@
# OAuth for Hubs
# OAuth 2.0
## What
OAuth provides a level of security to your documentation to restrict access to it. If your API is protected by OAuth, you will need to enable it for Try It Out. Enabling OAuth for Try It Out can be accomplished through two different methods: via Modeling or directly into the Hubs code.
> Stoplight supports OAuth 1.0 and 2.0
> OAuth 2.0 works explicitly for accessCode workflow
## How

View File

@@ -17,12 +17,10 @@ Hubs allows you to reference other sources to automatically populate your Hub wi
1. Select the Hub you wish to modify
2. Select **Design** view
3. Click on **Page Settings & TOC** at the top of the page
1. Select the **page** or **subpage** you wish to power
2. Under Page Type, select **Markdown**(for markdown files) or **OpenAPI** (for JSON or YAML files)
3. Input the specific data source or select from the drop-down menu
4. Input an inner data source (optional)
4. Click **Confirm**
3. Select the **page** or **subpage** you wish to power
4. Under Page Type, select **Markdown**(for markdown files) or **OpenAPI** (for JSON or YAML files)
5. Input the specific data source or select from the drop-down menu
6. Click **Confirm**
>Try it Out! Power a Subpage with an API Spec from the same project.

View File

@@ -0,0 +1,16 @@
# Grouping & Tagging Endpoints in OpenAPI
![Tagging and Grouping Endpoints](https://github.com/stoplightio/docs/blob/develop/assets/gifs/modeling-tagging.gif?raw=true)
## What
Use tags to group API endpoints and provide an additional layer of organization in your OpenAPI files. When rendering your OpenAPI in read view, Stoplight will group API endpoints by their first tag.
## How
1. Click **Tag** in the top Modeling toolbar
2. Input a **Name**
3. Input a **Tag description** (optional)
4. Select the endpoint you want to tag
5. Open the **tags** dropdown, and select the tag that you just created
6. Switch to read view and you should see the endpoint grouped under that tag in the sidebar

View File

@@ -20,13 +20,13 @@ Adding people to your Organization is the first step towards collaboration withi
### Magic Link
> Magic Link grants either Creator or Reader Permissions. Set accordingly
> Magic Link grants either Contributor or Reader Permissions. Set accordingly
#### Generating and Sending Magic Link
1. Select the **Organization** you wish to invite people to
2. Select the **People** tab
3. Click **Invite Member**
4. Select a role, either **Creator** or **Reader**
4. Select a role, either **Contributor** or **Reader**
5. Click **Generate Link**
6. Send link to invitee
@@ -34,7 +34,7 @@ Adding people to your Organization is the first step towards collaboration withi
1. Click on the **magic link**
2. If new to Stoplight, click **Register**
3. If you already have an account, **Login**
4. You now have Creator or Reader access to that Organization
4. You now have Contributor or Reader access to that Organization
---
**Related Articles**

View File

@@ -10,7 +10,7 @@ Roles and Permissions for members of Organizations can be managed and modified w
* Has access to Billing and Organization Settings
* **Administrator**
* Admins can update the org, its connections, and its members
* **Creator**
* **Contributor**
* Creators can update the org and its connections. They can view its members
## Who

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 MiB

After

Width:  |  Height:  |  Size: 989 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB