# Documentation Improvements

**URL:** https://community.convox.com/t/documentation-improvements/634
**Category:** Feature Requests
**Created:** [October 21, 2019, 4:50pm UTC](https://community.convox.com/t/documentation-improvements/634 "2019-10-21T16:50:14Z")
**Posts on this page:** 7
**Page:** 1

<div class="post-metadata">

### Author: ![ed\_convox](https://yyz1.discourse-cdn.com/flex029/user_avatar/community.convox.com/ed_convox/32/101_2.png) [@ed\_convox](https://community.convox.com/u/ed_convox)
#### Post date: [October 21, 2019, 4:50pm UTC](https://community.convox.com/t/documentation-improvements/634/1 "2019-10-21T16:50:14Z")

</div>

This is a thread to capture any feedback on areas you think the documentation site ([https://docs.convox.com/](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? 😊

---

<div class="post-metadata">

### Author: ![ed\_convox](https://yyz1.discourse-cdn.com/flex029/user_avatar/community.convox.com/ed_convox/32/101_2.png) [@ed\_convox](https://community.convox.com/u/ed_convox)
#### Post date: [October 21, 2019, 4:50pm UTC](https://community.convox.com/t/documentation-improvements/634/2 "2019-10-21T16:50:44Z")

</div>



---

<div class="post-metadata">

### Author: ![moises](https://yyz1.discourse-cdn.com/flex029/user_avatar/community.convox.com/moises/32/97_2.png) [@moises](https://community.convox.com/u/moises)
#### Post date: [October 31, 2019, 5:12pm UTC](https://community.convox.com/t/documentation-improvements/634/3 "2019-10-31T17:12:18Z")

</div>

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](https://docs.convox.com/application/environment) 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.

---

<div class="post-metadata">

### Author: ![moises](https://yyz1.discourse-cdn.com/flex029/user_avatar/community.convox.com/moises/32/97_2.png) [@moises](https://community.convox.com/u/moises)
#### Post date: [October 31, 2019, 5:25pm UTC](https://community.convox.com/t/documentation-improvements/634/4 "2019-10-31T17:25:41Z")

</div>

How resources are declared is not clear from the the docs. If you look at [convox-yml](https://docs.convox.com/application/convox-yml) docs it shows an example like this:

```auto
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](https://docs.convox.com/application/resources) docs it shows an example like this:

```auto
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?

---

<div class="post-metadata">

### Author: ![ed\_convox](https://yyz1.discourse-cdn.com/flex029/user_avatar/community.convox.com/ed_convox/32/101_2.png) [@ed\_convox](https://community.convox.com/u/ed_convox)
#### Post date: [October 31, 2019, 10:50pm UTC](https://community.convox.com/t/documentation-improvements/634/5 "2019-10-31T22:50:10Z")

</div>

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

---

<div class="post-metadata">

### Author: ![mrluc](https://yyz1.discourse-cdn.com/flex029/user_avatar/community.convox.com/mrluc/32/153_2.png) [@mrluc](https://community.convox.com/u/mrluc)
#### Post date: [May 24, 2020, 10:39pm UTC](https://community.convox.com/t/documentation-improvements/634/6 "2020-05-24T22:39:25Z")

</div>

I haven’t used Convox on a project in literally years – I think my use either predated Console or straddled its launch, I used it w/the Weave AMI a while back – and I’m coming back to it now that it’s using k8s + terraform (and is multi-cloud too, yikes that’s awesome!)

**First thing that I ran into: I often found/find myself clicking the very visible ‘Version 2’ in the sticky footer.**

Why? Well, there’s nothing in the docs that say ‘V3’, or ‘current’, or anything.

So I think “Maybe V2 is the next, latest-and-greatest!”

Also, my heuristic would normally be “which styles/css looking dated/older?”, but in this case that led me astray – they’re similar, and I like the denser current docs better, but I legitimately thought that the V2 docs ‘looked new’, just because of slightly more whitespace, content, and brighter links in the left-hand sidebar.

Of course, now I’ve learned the distinction, through repeated exposure/confusion – V3 / Gen 3 is the good stuff. 3. Not 2.

Just thinking that maybe a 3 should be up in the title of the docs then. Or the ‘Version 2’ should be ‘Version 2 (previous gen)’ or summat.

Edit: also, just noticed – the copyright in that footer is even newer on the V2 docs than the (unlabled-as) V3 docs, 2020 vs 2019.

---

<div class="post-metadata">

### Author: ![nathan.f77](https://yyz1.discourse-cdn.com/flex029/user_avatar/community.convox.com/nathan.f77/32/256_2.png) [@nathan.f77](https://community.convox.com/u/nathan.f77)
#### Post date: [March 20, 2025, 8:08am UTC](https://community.convox.com/t/documentation-improvements/634/7 "2025-03-20T08:08:24Z")

</div>

Hello, I often search for Convox docs via Google and I keep accidentally clicking on links to [docs-staging.convox.com](http://docs-staging.convox.com). These are always showing up in the first few results, and the docs are for Convox v2 racks, so I have to watch out whenever I click on any links.

e.g. [Convox Docs](https://docs-staging.convox.com/introduction/installation)

It would be great if you could add a robots.txt to [docs-staging.convox.com](http://docs-staging.convox.com) to prevent indexing so that [docs.convox.com](http://docs.convox.com) was the only site in the search results. Thanks!
