Download the file amplify.yml. Once downloaded, place this file into the root directory of your project.
Download the file docs-amplify-enhanced.yml. After downloading, place this file in the .github/workflows directory within your project.
Commit and push the changes to your GitHub repository. Make sure to push these changes to the 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.
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.
Expand Advanced settings and set Build image to python:3.8:
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.
Build previews only if the docs folder is updated¶
To build pull-request previews only if the pull-request edits the docs folder, set the following environment variables on your AWS Amplify application:
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.
Even if your repository is private, all the pull requests previews will be publicly available by default.
AWS deletes previews when the pull request gets merged or closed.