pwright / mobile-netlify

A repo to fork to preview changes to docs.aerogear.org

Previewing changes to docs.aerogear.org

This procedure allows you to preview a static website with proposed changes to docs.aerogear.org without installing Antora.

1. Fork this repo.

2. 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

   Important

   Edited site.yml must be in the master branch of mobile-netlify.

3. Create a Netlify account if you don’t already have one.

4. 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.

5. Select the fork of mobile-netlify you created in step one.

6. Select to use the master branch.

7. Click Deploy.

8. First deploy can take up to 10 minutes. Subsequent deploys will take ~30 seconds.

9. Netlify will deploy the rendered site on their servers with randomly generated URL, for example https://dreamy-shannon-845356.netlify.com

Troubleshooting

I am unable to build the docs. / The docs are not built correctly.

• 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

  • Antora Docs

  • Netlify Docs

Known issues

• There is an issue with the tabs in v1, they render incorrectly. However you can still navigate to each tab as follows: