Troubleshooting

On Slack

The first step in troubleshooting is to look at the docs-mbari-log Slack channel, where, upon a push to your repository, you should see the output from associated git commands (pull or clone, last commit comments), and site build and deployment.

• A successful result will look like so:

  https://bitbucket.org/mbari/odssdoc: ✅ Site built and deployed to https://docs.mbari.org/odss/

  If after seeing this successful result notification you are still not seeing the expected update, try a page reload in your browser.
  
  

• An error will look something like this:

  https://bitbucket.org/mbari/foo: 😨 ERROR: No mkdocs.yml file under docs, nothing done

  More details at https://docs.mbari.org/internal/_/_log

  So, go ahead and inspect that page https://docs.mbari.org/internal/_/_log in your browser.

On the docs machine

That https://docs.mbari.org/internal/_/_log link corresponds to the file /var/www/html/internal/_/_log on the server on the docs server. It contains the output generated from the adnanh/webhook service as well as from the underlying build/generation scripts.

That should pretty much cover all needs for debugging purposes.

If still facing issues, login as docsadm on the docs machine. Kill the current webhook process and launch a new one indicating -debug instead of -verbose:

webhook -port 9001 -debug -hooks /home/docsadm/mkdocs/docs-mbari-org-webhook-doc/hooks.json

Then try to reproduce the problem by pushing again to your doc repository while inspecting the output of the command above.

When done, do not forget to relaunch the regular webhook service.