This procedure allows you to preview a static website with proposed changes to docs.aerogear.org without installing Antora.
-
Fork this repo.
-
Edit the site.yml to point to your fork of mobile-docs and/or mobile-security and specify the branch you want to preview, for example:
- url: https://github.com/finp/mobile-docs.git branches: fix-things
and/or
- url: https://github.com/finp/mobile-security.git branches: fix-things
ImportantEdited site.yml
must be in themaster
branch ofmobile-netlify
. -
Create a Netlify account if you don’t already have one.
-
Click New site from Git in Netlify if not done before.
-
To trigger a redeploy with the changes in already created Netlify project:
-
Select the site in Netlify→Deploys→Trigger Deploy.
-
Skip to step 9.
-
-
-
Select the fork of
mobile-netlify
you created in step one. -
Select to use the
master
branch. -
Click Deploy.
-
First deploy can take up to 10 minutes. Subsequent deploys will take ~30 seconds.
-
Netlify will deploy the rendered site on their servers with randomly generated URL, for example
https://dreamy-shannon-845356.netlify.com
-
Ensure that you don’t touch any other settings in Netlify other than stated in the procedure above.
-
Ensure that the docs are written with correct AsciiDoc Syntax.
-
Try clearing the Netlify cache by selecting the checkbox Clear Cache in Trigger Deploy from step 4.
-
If all else fails, consult the docs