Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cornelcroi committed Aug 19, 2024
1 parent b7ff86f commit 151fb87
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/src/content/docs/features/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ The GitHub Integration feature of CloudFront Hosting Toolkit provides seamless c
- **Streamlined workflow**: Integrates directly with your existing Git-based development process.
- **Security**: OAuth-based authentication ensures secure access without the need for personal access tokens.

## Important Notes

- To create the connection, you must be the GitHub organization owner. For repositories not under an organization, you must be the repository owner.
- The GitHub Integration feature is not available in certain AWS regions. Check the AWS documentation for the latest information on regional availability.
- If your CodePipeline service role was created before December 18, 2019, you might need to update its permissions to use `codestar-connections:UseConnection` for AWS CodeStar connections.
> **Important**
>
> - To create the connection, you must be the GitHub organization owner. For repositories not under an organization, you must be the repository owner.
> - The GitHub Integration feature is not available in certain AWS regions. Check the AWS documentation for the latest information on regional availability.
> - If your CodePipeline service role was created before December 18, 2019, you might need to update its permissions to use `codestar-connections:UseConnection` for AWS CodeStar connections.
GitHub Integration bridges the gap between your development workflow and your hosting infrastructure, providing a cohesive and efficient deployment process that aligns with modern development practices while maintaining security and ease of use.
5 changes: 4 additions & 1 deletion docs/src/content/docs/user-guide/cli-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ Deploy your website:
cloudfront-hosting-toolkit deploy
```

**Important**: You typically only need to run the deploy command once after your initial init command. Subsequent code updates will be automatically deployed through the established pipeline.
> **Important**
>
> You typically only need to run the deploy command once after your initial init command. Subsequent code updates will be automatically deployed through the established pipeline.

You should only need to run deploy again if:

Expand Down

0 comments on commit 151fb87

Please sign in to comment.