Commit Graph

10 Commits

Author SHA1 Message Date
Adam Spiers af09b81759 distinguish more clearly between two types of box metadata
There are two types of box metadata, both in JSON format, so
we need to minimise the potential for confusion between them.
Renaming the component outside the box file to include the
word "catalog" makes it clear that this JSON document can
catalog potentially multiple boxes in one go.
2014-05-02 22:03:03 +01:00
Adam Spiers 0f8183426a reverse order of two box components
The metadata is optional whereas the box file is required, so it makes
sense to list the box file first.  It's also easier on the reader's
brain to start with the more obvious and easily understandable item
(which they'll probably be expecting to read about anyway) and save
the more surprising item till later.
2014-05-02 21:49:11 +01:00
Adam Spiers 606fc7a9e4 eliminate slightly confusing wording
It doesn't make sense to use the present tense when saying box files are
split into two components, when one of those components is the box file
and one is something else.

One better way of phrasing it would be to use the past tense: "Box files
were split into two separate components" but even that's not completely
correct, because the old format did not include the metadata JSON
document which is one of the new components.

So it's safer to just say that today there are two different components.
2014-05-02 21:38:25 +01:00
Adam Spiers 3ee1572e3c use monospace for technical terms where appropriate 2014-05-02 21:37:31 +01:00
Mitchell Hashimoto ece9db1183 website/docs: update box format [GH-3613] 2014-05-02 10:00:17 -07:00
Jack Pearkes aacdd5b837 website/docs: link to real vagrant cloud url
This is mostly for cookies and google. If you're logged in to
www, you won't be logged in to apex, and visa versa. Also a Vagrant
Cloud bug but wanted to make it consistent on this end.
2014-03-13 09:59:39 -04:00
Mitchell Hashimoto c605855634 website/docs: update docs for checksums on versioned boxes 2014-03-01 12:08:27 +01:00
Mitchell Hashimoto 286a503cb6 website/docs: docs for box versioning 2014-02-05 21:20:25 -08:00
Mitchell Hashimoto b5fd021694 website/docs: page titles on everything, cover more info 2013-09-06 09:50:43 -07:00
Mitchell Hashimoto d03110eaa3 website: add docs back to the main Vagrant repo 2013-09-03 11:08:28 -07:00