-
Notifications
You must be signed in to change notification settings - Fork 181
Docs on manually triggering builds and previews #784
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ccdc9da
Update preview deployment info
ethanpalm 8af723d
add images
ethanpalm 8a827b8
💅
ethanpalm 41421a1
add deployments page
ethanpalm d34b731
add images
ethanpalm 2148171
update images
ethanpalm 756c04e
add reviewer feedback
ethanpalm a0e8526
polish
ethanpalm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -139,6 +139,7 @@ | |
|
||
] | ||
}, | ||
"guides/deployments", | ||
"contact-support" | ||
] | ||
}, | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: "Deployments" | ||
description: "Troubleshoot your deployments" | ||
icon: "boxes" | ||
--- | ||
|
||
Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. | ||
|
||
If your latest changes are not appearing on your live site, first check that the GitHub app is installed on the account or organization that owns your docs repository. See [GitHub troubleshooting](/settings/github#troubleshooting) for more information. | ||
|
||
If the GitHub app is connected, but changes are still not deploying, you can manually trigger a rebuild from your dashboard. | ||
|
||
## Manually triggering a deployment | ||
|
||
<Steps> | ||
<Step title="Verify your latest commit was successful."> | ||
Check that your latest commit appears in your docs repository and did not encounter any errors. | ||
</Step> | ||
<Step title="Manually trigger a deployment."> | ||
Go to your [dashboard](https://dashboard.mintlify.com) and select the deploy button. | ||
<Frame> | ||
<img src="/images/deployments/manual-update-light.png" alt="The manual update button emphasized with an orange rectangle." className="block dark:hidden" /> | ||
<img src="/images/deployments/manual-update-dark.png" alt="The manual update button emphasized with an orange rectangle." className="hidden dark:block" /> | ||
</Frame> | ||
</Step> | ||
</Steps> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,20 +5,51 @@ icon: "scan-eye" | |
--- | ||
|
||
<Info> | ||
Preview Deployments are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). Please{" "} | ||
Preview deployments are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). Please{" "} | ||
<a href="mailto:[email protected]">contact sales</a> for more information. | ||
</Info> | ||
|
||
Preview Deployments allow you to preview changes to your docs in a live deployment without merging those changes to your production branch. | ||
Preview deployments let you see how changes to your docs will look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes. | ||
|
||
If you have created a pull or merge request when using Git, the generated preview URL will be available as a comment from the Mintlify bot in the PR. This URL will always reflect the latest deployment changes. | ||
## Creating preview deployments | ||
|
||
## Sharing Preview Deployments | ||
Preview deployments are created automatically through pull requests or manually from your dashboard. | ||
|
||
After generating a preview URL, you can share that link with anybody for them to view. | ||
### Automatic previews | ||
|
||
### Authenticated Preview Deployments | ||
When you create a pull request, the Mintlify bot automatically adds a link to view the preview deployment in your pull request. The preview updates each time you push new commits to the branch. | ||
|
||
If you'd like to restrict access to your Preview Deployments, you can set up preview deployment authentication. When using this authentication method, only Mintlify authenticated users will be able to access your Preview Deployments. | ||
<Frame> | ||
<img src="/images/previews/preview-deployment-light.png" alt="Link to view deployment in the pull request timeline" className="block dark:hidden" /> | ||
<img src="/images/previews/preview-deployment-dark.png" alt="Link to view deployment in the pull request timeline" className="hidden dark:block" /> | ||
</Frame> | ||
|
||
To set up preview deployment authentication, please [contact sales](mailto:[email protected]). | ||
### Manual previews | ||
|
||
You can manually create a preview for any branch if you are on a Growth or Enterprise plan or have the preview deployment add-on. | ||
|
||
1. Go to your [dashboard](https://dashboard.mintlify.com/). | ||
2. Select **Previews**. | ||
3. Select **Create preview**. | ||
4. Enter your branch name. | ||
5. Select **Create deployment**. | ||
|
||
## Redeploying a preview | ||
|
||
Redeploy a preview to refresh content or retry after a failed deployment. | ||
|
||
1. Select the preview from your [dashboard](https://dashboard.mintlify.com/). | ||
2. Select **Redeploy**. | ||
|
||
<Frame> | ||
<img src="/images/previews/redeploy-preview-light.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="block dark:hidden" /> | ||
<img src="/images/previews/redeploy-preview-dark.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="hidden dark:block" /> | ||
</Frame> | ||
|
||
## Sharing preview deployments | ||
|
||
Preview deployments can be publicly accessible or restricted to authenticated users. | ||
|
||
**Public access**: Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes. | ||
|
||
**Restricted access**: Enable preview deployment authentication to limit preview access to authenticated Mintlify users only. [Contact sales](mailto:[email protected]) to set up authentication for your previews. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.