search

Neurotech-HQ / sarufi-docs

Sarufi API documentation
https://docs.sarufi.io/
MIT License
10 stars 13 forks source link

Add CI for testing and preview builds #6

Open bkmgit opened 1 year ago

bkmgit commented 1 year ago

https://docusaurus.io/docs/deployment

Kalebu commented 1 year ago

Hi Benson

Thank you for the recommendation, you can also contribute it by Create a PR

Let me know incase you need any further details for you to contribute @bkmgit

bkmgit commented 1 year ago

Can make a PR. For deployment previews, do you have a preferred provider, for example Vercel, Netlify, Cloudflare

Kalebu commented 1 year ago

Yes vercel but also okay with the rest

bkmgit commented 1 year ago

Ok, thanks. It seems that docs.sarufi.io is hosted on AWS, so possibly that could also be used for previews? See for example https://significa.co/blog/deploy-previews-aws

bkmgit commented 1 year ago

@Kalebu Started on script to build the site using GitHub actions https://github.com/bkmgit/sarufi-docs/blob/ci-build/.github/workflows/build-site.yml

bkmgit commented 1 year ago

Possibly also helpful https://github.com/rossjrw/pr-preview-action

bkmgit commented 1 year ago

@Kalebu Usng CI to generate and deploy the site. A sample deployment is available here. The CI file is available here At present it deploys in the organization where the changes are made. it may be better to deploy within https://github.com/Neurotech-HQ/sarufi-docs when pull request is made and then generate a link note that a directory is made for each deployment. These can be cleaned up, say after one week.

Otherwise, if you prefer to use Netflify/Cloudflare/Vercel/AWS please make an account that I can use to configure deployments on.