Convox Community

Documentation Improvements

This is a thread to capture any feedback on areas you think the documentation site (https://docs.convox.com/) is lacking, things you spot that are out of date or confusing, or entirely new docs that deserve to be created.

So, what would you like to see on the docs site? :blush:

One area that I think it could be more clear that caught me was that the environment variable if you set it in the console or via cli, you must also add it to the conovox.yml file. Even thought the docs do say

Environment variables must be specified to be available to your running application.

In my opinion is not clear enough that they must existe in the convox.yml and had to spend bunch of time figuring out why they were not working correctly.

How resources are declared is not clear from the the docs. If you look at convox-yml docs it shows an example like this:

resources:
  maindb:
    type: mysql
services:
  web:
    resources:
      - maindb

where resources and services are at the same level of indentation and under the web services you declare the resouce.

But in the resources docs it shows an example like this:

resources:
  maindb:
    type: mysql
  services:
    web:
      resources:
        - maindb

where services is inside the resources and also declare the resource inside the web service.

What is the correct indentation?

Thanks for spotting that @moises, the first example is correct, I’ll fix up the other document!