-
Couldn't load subscription status.
- Fork 0
docs: Fix broken link and improve clarity in Bitbucket integration guide #107
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
Open
promptless
wants to merge
2
commits into
main
Choose a base branch
from
promptless/fix-github-bitbucket-guides-links-clarity
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
|
|
@@ -63,28 +63,33 @@ This authentication model ensures that Promptless only has access to the reposit | |
|
|
||
| ## Repository Refresh | ||
|
|
||
| If you add new repositories to your Bitbucket workspace after setting up the integration, you can refresh the repository list: | ||
| After adding new repositories to your Bitbucket workspace, you can choose to update the repository list in Promptless: | ||
|
|
||
| 1. Go to the **Integrations** page in your Promptless dashboard | ||
| 2. Find the Bitbucket integration | ||
| 3. Click the **Refresh Repositories** button to update the list of available repositories | ||
| 1. Go to the [integrations page](https://app.gopromptless.ai/integrations) | ||
| 2. Find the Bitbucket integration card | ||
| 3. Click the "refresh repos" icon (circular arrow) to update the repository list | ||
|
|
||
| The new repositories will be available when creating or editing projects in Promptless. Note that it may take a few minutes for the changes to be reflected in the Promptless dashboard. | ||
|
|
||
| ## Webhook Management | ||
|
|
||
| Promptless automatically sets up webhooks in your Bitbucket repositories to monitor for pull request events. These webhooks: | ||
| Promptless automatically sets up webhooks in your Bitbucket workspace when you connect a repository. These webhooks listen for pull request events (opened, updated, merged, or declined) and trigger documentation updates when changes are detected. | ||
|
|
||
| To view the webhooks: | ||
|
|
||
| 1. Go to your Bitbucket workspace settings | ||
| 2. Navigate to **Webhooks** under **Workspace settings** | ||
| 3. Look for webhooks created by Promptless | ||
|
|
||
| - Trigger Promptless when pull requests are created or updated | ||
| - Send only the necessary information about changes to Promptless | ||
| - Can be customized to focus on specific events | ||
| Need help modifying or troubleshooting webhook behavior? Reach out to [[email protected]](mailto:[email protected]). | ||
|
|
||
| ## Usage | ||
|
|
||
| Once configured, the Bitbucket integration works similarly to the GitHub integration: | ||
| Once configured, the Bitbucket integration works as follows: | ||
|
|
||
| 1. When a pull request is opened or updated in your monitored repositories, Promptless is automatically triggered | ||
| 2. Promptless analyzes the changes to determine if documentation updates are needed | ||
| 3. If updates are needed, Promptless generates the appropriate documentation changes | ||
| 4. Promptless adds a comment to your Bitbucket pull request with a link to review the documentation changes | ||
| 5. You can review and approve the suggested documentation updates in the Promptless dashboard | ||
| 1. When a pull request is opened or updated in your monitored repositories, Promptless analyzes the changes to determine if documentation updates are needed | ||
| 2. If updates are needed, Promptless creates the documentation changes and stores them in your Promptless dashboard | ||
| 3. Promptless adds a comment to your Bitbucket pull request with a link to review the changes. You can provide follow-up instructions or approve the changes | ||
| 4. Approved documentation updates are published to your configured documentation repository | ||
|
|
||
| For more information on how triggers work in general, see the [Triggers](/docs/core-concepts/triggers) documentation. | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rewrite