Compare commits

..

2 Commits

Author SHA1 Message Date
Robert Wallach
0165c5c1b3 Update export-static-html.md 2018-05-08 12:33:50 -05:00
Chris Lott
88a6977ff8 How to serve locally on your computer 2018-05-02 13:58:55 -05:00
3 changed files with 14 additions and 71 deletions

View File

@@ -1,48 +0,0 @@
# 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,16 +0,0 @@
# 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