Skip to content

Commit

Permalink
Pam 215 studio move to plaform (#585)
Browse files Browse the repository at this point in the history
Migrated content to platform
  • Loading branch information
pamgoodrich committed Jan 31, 2022
1 parent 2298c97 commit 4902d76
Show file tree
Hide file tree
Showing 21 changed files with 14 additions and 923 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ When it comes to API modeling, avoiding duplication of effort can be the differe

Studio allows you to quickly and easily find and reuse the objects you need, as you need them. No more recreating models for different endpoints, no more having to update dozens of different endpoints because a new field was added.

To find out more about how you can leverage references to scale your API consistency, see [here](./docs/Design-and-Modeling/07-using-references.md).
To find out more about how you can leverage references to scale your API consistency, see [here](https://meta.stoplight.io/docs/platform/branches/pam-215-doc-overview-updates/ZG9jOjM2OTM3Mjk0-use-references).

### Technical Documentation

Expand All @@ -58,15 +58,15 @@ Enforce correctness and best practices with the native [Spectral](https://stopli

Clicking on errors or warnings also brings you to exactly where they are located in the document, making it easy to fix errors at the source.

To find out more about Spectral and how validations can improve your API design workflow, see [here](./docs/Design-and-Modeling/08-validation-style-guide.md).
To find out more about Spectral and how validations can improve your API design workflow, see [here](https://meta.stoplight.io/docs/platform/branches/pam-215-doc-overview-updates/ZG9jOjMwMDI3MjA2-overview).

### Built-in Mocking

When running locally, Studio will automatically start a local [Prism mock server](https://stoplight.io/prism/) for every API defined in your project, and keep that mock server up to date as you change your designs.

![Mocking allows you to quickly test the look and feel of your API before jumping into the code](assets/images/studio-mocking.png)

To find out more about Prism and how mocking can be used to streamline your API development process, see [here](./docs/Design-and-Modeling/06-mock-servers.md).
To find out more about Prism and how mocking can be used to streamline your API development process, see [here](https://meta.stoplight.io/docs/platform/branches/pam-215-doc-overview-updates/ZG9jOjM2OTM3Mjg4-work-with-mock-servers).

### Bring Your Own Repository

Expand Down
8 changes: 0 additions & 8 deletions docs/01-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,4 @@ focus: false

4. Add global information about the API (summary, description, servers, and more).

5. Continue on to the [API Design Guide](./Design-and-Modeling/01-getting-started.md) to get started designing APIs.

> #### Learn more about API designs
>
>- [Understanding the Directory Structure](Basics/02-working-with-files.md#directory-structure)
>- [Working with Models](./Design-and-Modeling/03-http-endpoints.md)
>- [Shared Components](./Design-and-Modeling/04-shared-components.md)
>- [Using References](./Design-and-Modeling/07-using-references.md)
>- [Validation and Linting](./Design-and-Modeling/08-validation-style-guide.md)
16 changes: 7 additions & 9 deletions docs/02-git-credentials.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,27 @@
# Git Credentials
# Git Credentials

Studio Web will use the Git Credentials associated with your Stoplight account depending on the Git provider being used. That means if you connect a GitHub and a BitBucket account, and work on a Git Project which is hosted on BitBucket, it's going to know to use the BitBucket credentials. You don't need to think about it at all.
<!-- Move this topic to platform -->

Studio Desktop v1.x used to ask you to log in to your Stoplight account in order to use Git functionality for things like commits, pushing, pulling, etc. but you no longer need to bother with that. You can work with any VCS provider by adding your Git credentials for that provider.
Studio Web uses the Git Credentials associated with your Stoplight account, depending on the Git provider being used. That means if you connect a GitHub and a BitBucket account, and work on a Git Project which is hosted on BitBucket, it's going to know to use the BitBucket credentials. You don't need to think about it at all.

You should be asked to add credentials for a provider the first time you add that project, but if for some reason that doesn't work, or you need to change them, here's how it works.

## Adding Credentials for Github
## Adding Github Credentials in Studio Desktop

1. Create a [new personal access token](https://github.com/settings/tokens/new) (more information in the [creating personal access tokens guide on Github](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).

2. Choose "repo" permissions to allow enable read/writing files in your Git repository then generate the token.

![image](../assets/images/git-creds-github-token.png)

3. Click the Cog icon bottom left to open Project Settings, click Project Settings, and click the "+ Credential" button.
3. In Studio Desktop, open a Git project.

4. From the hamburger menu, select **Git > Manage Credentials**, and then add:

- **Host URL:** `https://github.com/`
- **Username:** Your GitHub username, e.g.: `janesmith123`
- **Password:** The Personal Access Token you just created
- **Author Name:** A display name, usually a full name, e.g.: `Jane Smith`
- **Author Email:** Your GitHub email address

Job done! You should now be able to push to GitHub.

> Keep in mind that these credentials are stored on your local computer as a security measure, so if you switch computers you'll need to repeat this step.
## Other Git Providers
Expand Down
1 change: 0 additions & 1 deletion docs/Basics/02-working-with-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Studio supports files in multiple formats:
- **Model**: Reusable API components (YAML or JSON)
- **Article**: Supplemental Markdown files (Markdown)
- **Image**: Supplemental images (JPEG, JPG, PNG, and GIF)
- **Style Guides**: For customizing the [validation and linting](../Design-and-Modeling/08-validation-style-guide.md)
- **Configuration Files**: For Stoplight project configuration and table of contents

<!-- theme: Warning -->
Expand Down
2 changes: 1 addition & 1 deletion docs/Basics/ui-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ You can customize the [project sidebar](https://meta.stoplight.io/docs/platform/
Use the main editor panel to design APIs and write documentation. Choose different views:
- **Form**: Offers an intiutive editor for APIs, endpoints, and models.
- **Code**: Enables the code view for applicable files.
- **Preview**: Provides a preview of what the selected file will look like when it is published. For API operations, the [Try It](../Design-and-Modeling/03-http-endpoints.md) feature is available in Preview mode.
- **Preview**: Provides a preview of what the selected file will look like when it is published. For API operations, the [Try It](https://meta.stoplight.io/docs/platform/ZG9jOjM2OTM3Mjky-try-it) feature is available in Preview mode.

**Validation and Linting** displays issues related to your API Specification (powered by [Spectral](https://meta.stoplight.io/docs/spectral/ZG9jOjYx-overview)). Select to expand window and view error and warning details and locations.

Expand Down
8 changes: 1 addition & 7 deletions docs/Design-and-Modeling/01-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,4 @@ Once you have your API described in Stoplight Studio, you can:

## Getting Started

There are a few ways to get started designing your API with Stoplight Studio:

- [Create an API from scratch](../Basics/02-working-with-files.md)
- [Understanding the Directory Structure](../Basics/02-working-with-files.md#directory-structure)
- [Working with Models](./03-http-endpoints.md)
- [Using References](./07-using-references.md)
- [Validation and Linting](./08-validation-style-guide.md)
See our [API design documentation](https://meta.stoplight.io/docs/platform/ZG9jOjIwMTI3Nw-overview).
97 changes: 0 additions & 97 deletions docs/Design-and-Modeling/03-http-endpoints.md

This file was deleted.

148 changes: 0 additions & 148 deletions docs/Design-and-Modeling/04-shared-components.md

This file was deleted.

0 comments on commit 4902d76

Please sign in to comment.