Compare commits

..

2 Commits

Author SHA1 Message Date
Robert Wallach
08169adc02 Update export-static-html.md 2018-04-27 10:43:13 -05:00
Robert Wallach
2439834dbc Create export-static-html.md 2018-04-26 12:52:29 -05:00
21 changed files with 28 additions and 101 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:
### JSON
### YAML
- Documentation
- Modeling
- Testing

View File

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

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,25 +4,18 @@
> 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. 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.
## 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.
## 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
4. Click the **Build** button to start the build process
3. Choose a **Hub** or **OAS** file to create a build from
4. Click the **Build** button to start the build process.
> 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`)
> 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
---
**Related Articles**
- [Documentation with Hubs](/documentation/introduction)

View File

@@ -1,10 +1,10 @@
# OAuth 2.0
# OAuth for Hubs
## 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.
> OAuth 2.0 works explicitly for accessCode workflow
> Stoplight supports OAuth 1.0 and 2.0
## How

View File

@@ -17,10 +17,12 @@ 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. 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**
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**
>Try it Out! Power a Subpage with an API Spec from the same project.

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

View File

@@ -20,13 +20,13 @@ Adding people to your Organization is the first step towards collaboration withi
### Magic Link
> Magic Link grants either Contributor or Reader Permissions. Set accordingly
> Magic Link grants either Creator 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 **Contributor** or **Reader**
4. Select a role, either **Creator** 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 Contributor or Reader access to that Organization
4. You now have Creator 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
* **Contributor**
* **Creator**
* Creators can update the org and its connections. They can view its members
## Who

Binary file not shown.

Before

Width:  |  Height:  |  Size: 989 KiB

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 958 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

View File

@@ -1,19 +1,15 @@
# Stoplight v4.1.0 Release
This update includes fair use billing, magic links, custom css, and more.
# Stoplight v4.1.0Fair Use Billing, Magic Links, Custom CSS, Landing Pages, Token Generation
The first major update to Stoplight Next is live! Weve been hard at work building out a bunch of new exciting features based on all your invaluable feedback. Now lets dig in!
## New 🚀
- **[Fair Use Billing](https://docs.stoplight.io/platform/getting-started/billing)**: Our paid plans now only count active members that have created a project or updated project files in the past 30 days. This better aligns cost to value, and results in a lower bill in all cases. Now your members will only be added to your bill if and when they start creating content on Stoplight. Unleash your Engineers! 
- **Annual Billing**: Save up to 20%.
- **[Magic Invite Links](https://docs.stoplight.io/platform/organizations/invite-people)**: Share it via email, Slack, and other channels to easily onboard members in your organization. Fair use billing means they wont count until they actually start creating content. Abra Kadabra. 
- **[Fair Use Billing](https://docs.stoplight.io/platform/getting-started/billing)**: We instituted a fair use billing policy because we wanted our users to only pay for what they use. This means that you will only pay for the users actively contributing on your account in any given 30 day billing cycle. Unleash your Engineers! 
- **Annual Billing**: We enabled a year long billing option that helps you save up to 20%. 
- **[Magic Invite Links](https://docs.stoplight.io/platform/organizations/invite-people)**: Invite people to your Organization or Project simply by generating a link and sending it. Abra Kadabra. 
- **[Custom CSS](https://docs.stoplight.io/documentation/design/custom-css)**: Add some custom style and flair to your documentation with Custom CSS. 
- **Custom HTML Landing Pages**: Create beautiful custom landing pages to greet and direct your users. 
- **[OAuth2 Token Generation in Hubs Try it Out](https://docs.stoplight.io/documentation/oauth-hubs)**: If your API is protected by OAuth2, you can now generate tokens in the Try it Out block.
- **[OAuth2 Token Generation in Hubs Try it Out](https://docs.stoplight.io/documentation/oauth-hubs)**: If your API is protected by OAuth2, you can now generate tokens to enable Try it Out. 
## Enhancements 💪
- **Relative $refs**: References from one file to another in the same project are now represented with relative URLs. For example, `./models/user.json` instead of `https://exporter.stoplight.io/45/master/models/user.json`. This has a number of benefits, such as increased portability. It also sets the stage for better desktop local file editing and versioning.
- **Published hubs now support Internet Explorer 11**
- **IE 11 Support for Published Hubs**: IE 11 now renders documentation created in Hubs. 
Please reach out via chat or support@stoplight.io if you have any questions about the above changes.