initial commit with stuff from arise
Some checks are pending
Deploy Arise to html branch / Deploy Arise (push) Waiting to run
Some checks are pending
Deploy Arise to html branch / Deploy Arise (push) Waiting to run
This commit is contained in:
commit
0faf445b39
62 changed files with 3401 additions and 0 deletions
26
docs/guides/getting-started/README.md
Normal file
26
docs/guides/getting-started/README.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# Getting Started with Arise
|
||||
|
||||
Welcome to Arise! Arise is designed to be a cloud-native application. This guide will walk you through the basics of how to build and deploy your website to the cloud using Arise.
|
||||
|
||||
It's actually very simple to get a website up and running using Arise.
|
||||
|
||||
## Cloud Deployments
|
||||
|
||||
1. Fork this repo
|
||||
2. Edit the global Arise site configuration file at `/arise-source/config/arise.conf`
|
||||
3. Edit the example site in `/arise-source/` to your liking
|
||||
- Check out the page on [creating pages](../creating-arise-pages/README.md) for more information on the specifics of how Arise pages work
|
||||
4. Configure your `/arise-source/robots.txt` with your site domain and any additional crawler settings you'd like to set.
|
||||
5. Upon any new commit to the site source files, the GitHub Actions workflow present in `/.github/workflows/` will automatically build your website based on the contents of `/arise-source/` and output the built files to your `html` branch.
|
||||
6. Configure your cloud web host of choice to automatically deploy a static site from the `html` branch of your repo. Specific instructions for several notable providers can be found below:
|
||||
- [Cloudflare Pages](cloudflare/README.md)
|
||||
- [DigitalOcean](digitalocean/README.md)
|
||||
- [GitHub Pages](github-pages/README.md)
|
||||
|
||||
Congrats! Your site is now up and running! If you want to make changes to your website, you can simply make a commit to the `main` branch of your repo source files and it will automatically be deployed to your live website! Pretty wiz, yeah?
|
||||
|
||||
## Running Arise Locally (Not Recommended)
|
||||
|
||||
You can also clone this repo and run Arise locally. However, this not recommended because you are honestly wasting your time by manually running the build process and managing the build artefacts instead of just sitting back and letting CI/CD do the work for you.
|
||||
|
||||
If you REALLY want to run Arise locally, please refer to [this guide](../running-arise-locally/README.md).
|
||||
21
docs/guides/getting-started/cloudflare/README.md
Normal file
21
docs/guides/getting-started/cloudflare/README.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Deploying to Cloudflare Pages
|
||||
|
||||
This guide assumes that you have completed steps 1-3 from [Getting Started](../README.md) and have a successfully build website in your `html` branch.
|
||||
|
||||
1. Navigate to your [Cloudflare Dashboard](https://dash.cloudflare.com) and click **Pages** in the sidebar.
|
||||
2. Click **Create a project** > **Connect to Git**.
|
||||
3. Add your account and select your repository. Click **Begin setup** to proceed.
|
||||
4. Name your project whatever you'd like and select `html` as your **Production branch**. Leave all the optional **Build settings** blank-- we don't need any of these.
|
||||
<p align="center"><img src="cloudflare-1.png" alt="Screenshot: Cloudflare Pages Deploy Settings" width=50% height=50% /></p>
|
||||
|
||||
5. Click **Save and Deploy**
|
||||
6. **IMPORTANT**: Click **Pages** in the sidebar and click on your site.
|
||||
7. Click **Settings**.
|
||||
8. Click **Builds & deployments**.
|
||||
9. Click **Configure Preview deployments**.
|
||||
10. Click **None** and **Save**.
|
||||
<p align="center"><img src="cloudflare-2.png" alt="Screenshot: Disable Cloudflare Preview deployments" width=50% height=50% /></p>
|
||||
|
||||
As of this writing, if you don't IMMEDIATELY disable preview deployments, Cloudflare will automatically generate live externally-accessible "preview" URLs for every single branch in your website repo (even if your repo is private). Based on how Arise works, this will not only result in previews that are broken and do not work, but it will disclose literally everything in your repo including potentially WIP pages if your repo is private. To put a cherry on top, after preview deployments have been build for a branch, you cannot delete them without deleting and re-adding your entire damn website. What a stupid-ass system.
|
||||
|
||||
Anyway, rants aside, your site should now be up and running on Cloudflare Pages! Congrats! If you'd like to use a custom domain, please review Cloudflare's [custom domains guide](https://developers.cloudflare.com/pages/platform/custom-domains/) as that is outside of the scope of this documentation.
|
||||
BIN
docs/guides/getting-started/cloudflare/cloudflare-1.png
Executable file
BIN
docs/guides/getting-started/cloudflare/cloudflare-1.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 521 KiB |
BIN
docs/guides/getting-started/cloudflare/cloudflare-2.png
Executable file
BIN
docs/guides/getting-started/cloudflare/cloudflare-2.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 284 KiB |
13
docs/guides/getting-started/digitalocean/README.md
Normal file
13
docs/guides/getting-started/digitalocean/README.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Deploying to DigitalOcean
|
||||
|
||||
This guide assumes that you have completed steps 1-3 from [Getting Started](../README.md) and have a successfully build website in your `html` branch.
|
||||
|
||||
1. Navigate to the [Apps](https://cloud.digitalocean.com/apps) pane in your DigitalOcean account.
|
||||
2. Click **Create App**.
|
||||
2. Select **GitHub** as your source, select your repository, and define `html` as your target branch. Leave `/` as your source directory. Leave the box checked next to **Autodeploy** so that your site will automatically pull new updates whenever you push a commit to `main` in your Arise site repo on GitHub. Hit **Next** to proceed.
|
||||
<p align="center"><img src="digitalocean-1.png" alt="Screenshot: DigitalOcean Deploy Settings" width=50% height=50% /></p>
|
||||
|
||||
3. Click **Skip to Review** to skip past all the other optional settings-- we don't need any of them.
|
||||
4. Click **Create Resources**.
|
||||
|
||||
Congrats! Your Arise website is now live on DigitalOcean. If you'd like to use a custom domain, please review DigitalOcean's [custom domains guide](https://docs.digitalocean.com/products/app-platform/how-to/manage-domains/) as that is outside of the scope of this documentation.
|
||||
BIN
docs/guides/getting-started/digitalocean/digitalocean-1.png
Executable file
BIN
docs/guides/getting-started/digitalocean/digitalocean-1.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 294 KiB |
15
docs/guides/getting-started/github-pages/README.md
Normal file
15
docs/guides/getting-started/github-pages/README.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# Deploying to GitHub Pages
|
||||
|
||||
This guide assumes that you have completed steps 1-3 from [Getting Started](../README.md) and have a successfully build website in your `html` branch.
|
||||
|
||||
This guide will also assume that you don't already have a GitHub Pages site and are using Arise to host your User Site. For Project Sites, please review [GitHub's documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites).
|
||||
|
||||
Frankly, the configuration annoyance of GitHub Pages with multiple hosted sites is a pretty good reason to use a provider like [Cloudflare Pages](../cloudflare/README.md) or [DigitalOcean](../digitalocean/README.md) instead.
|
||||
|
||||
1. Name your repo to **yourusername.github.io**.
|
||||
2. Navigate to your repo and click **Settings** in the navbar.
|
||||
3. Click **Pages** in the sidebar.
|
||||
4. Under the dropdown for **Source**, click **Deploy from a branch**.
|
||||
5. Select the `html` branch. Leave `/ (root)` as the folder and click **Save**.
|
||||
|
||||
Congrats! Your Arise website is now live on GitHub Pages. If you'd like to use a custom domain, please review GitHub's [custom domains guide](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/) as that is outside of the scope of this documentation.
|
||||
Loading…
Add table
Add a link
Reference in a new issue