Skip to content
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

Suggested documentation changes for github integration with adobe commerce cloud #46

Merged
merged 4 commits into from
Sep 17, 2024

Conversation

marmureanuweb
Copy link
Contributor

@marmureanuweb marmureanuweb commented Sep 17, 2024

When you use magento-cloud integration:add --type=github --project=XXXXXX --base-url=https://github.com --token=XXXXXXXXX --repository={account}/{repository-name} you might end up with an error like "The integration is invalid. The following error was found: repository: Unable to connect to GitHub: repository not found". Even though the repository exists and token has all the proper permissions, documentation is misleading because it does not PROPERLY and FULLY mentioning that "base-url" is needed only when repository is on a private server. This needs to be as clear as possible.

Purpose of this pull request

This pull request (PR) updated the documentation for integration of Adobe Commerce Cloud with a private repository from Github

Affected pages

When you use `magento-cloud integration:add --type=github --project=XXXXXX --base-url=https://github.com --token=XXXXXXXXX --repository={account}/{repository-name} ` you might end up with an error like "The integration is invalid.
The following error was found: repository: Unable to connect to GitHub: repository not found". Even though the repository exists and token has all the proper permissions, documentation is misleading because it does not PROPERLY and FULLY mentioning that "base-url" is needed only when repository is on a private server. This needs to be as clear as possible.
@marmureanuweb marmureanuweb changed the title Suggest documentation changes for github integration Suggested documentation changes for github integration with adobe commerce cloud Sep 17, 2024
@jeff-matthews jeff-matthews self-assigned this Sep 17, 2024
@jeff-matthews jeff-matthews added major-update Significant updates to content technical Changes to code, examples, or technical processes and removed major-update Significant updates to content labels Sep 17, 2024
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix @marmureanuweb.

help/cloud-guide/integrations/github.md Outdated Show resolved Hide resolved
@jeff-matthews
Copy link
Contributor

@devops-devdocs import the pr

@devops-devdocs
Copy link

@devops-devdocs imported this pull request

@jeff-matthews
Copy link
Contributor

@devops-devdocs import the pr

@devops-devdocs
Copy link

@devops-devdocs imported this pull request

@adobe-bot adobe-bot merged commit 122af9e into AdobeDocs:main Sep 17, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical Changes to code, examples, or technical processes
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants