[BUG] Unclear instructions for GitHub bot user authorization method

[VincentTam]

Context

In response to my PR daattali/beautiful-jekyll#782 (comment), the theme's owner wants to deploy a test API instance, but he finds the instructions in "Getting Started" unclear. The "once your API instance has been setup" has puzzled him.

Problem

The instruction is referring to an object not yet exists (your API instance). It's easy for a busy person to overlook the word "once". That blocks his/her comprehension of the instructions.

Suggestion

I propose that to drop the mention of "API instance", which is to be set up in the next section, and simply say something like "proceed to next section". Detail the GitHub bot invitation link after the API env var are correctly config.

[daattali]

To add to this: the major issue I have is not with the wording, but rather with the fact that there are missing steps. A "Getting Started" guide on the official documentation should be complete and clear in my opinion. Even if looking at "Option 1: Authenticate as a GitHub Application" (here) the same issue comes up - the very first step says to use "{STATICMAN_BASE_URL}/v1/webhook" but there is no instructions on how to get this base URL. Therefore this documentation is incomplete and requires prospective users to search the internet for instructions.

[gtarnaras]

Hey all, just to add my 2 cents on this issue... I am getting a 503 from staticman after I deployed it on Heroku following the documentation. Something is either wrong with the staticman app or with its docs (I followed it step by step). I've spent a couple of hours trying to fix it but the docs are a bit messy at the moment (especially the references to v2/v3). If it helps I used the option with the github bot. I'll try to check the other option with the github app as well to see if it works. I'd really love to see this working and clean up the docs a bit if you need some help/someone to test it.