Copy the file amplify.yml in the project root directory.
Commit and push the changes to GitHub (default branch).
Note
To complete the installation, we must list the repository in the company’s AWS account. Contact us in Slack (#scylla-docs channel) to set this configuration for you.
On this page, you should verify that the amplify.yml file was imported successfully.
Under Build and test settings, you should see the message “We detected amplify.yml in your repository and will use it to deploy your app.”. If it is not the case, review Installation.
Once the file is imported automatically, choose Next.
On the Review page, choose Save and deploy.
On the left sidebar, go to Previews page and choose Preview Settings.
Select the default branch from the list and choose Manage.
Turn on pull request previews.
The next time you submit a pull request for the branch, AWS Amplify will build the docs automatically and share a preview URL as a pull request comment.
Previews builds have a 15 min limit. Nevertheless, we recommend you make sure the command makedirhtml does not take more than 3 minutes to build on average.
If your repository is private, all the pull requests previews will be publicly available by default.
AWS Amplify only builds previews if the docs folder receives an update.
AWS deletes previews when the pull requets gets merged or closed.