docs icon indicating copy to clipboard operation
docs copied to clipboard

Update database documentation

Open lukasschlueter opened this issue 7 years ago • 1 comments

Currently, the docs for generating and destroying db models (https://gobuffalo.io/en/docs/db/models/) include the following paragraph:

You can remove generated model by running: $ soda destroy model [name] Or in short form: $ soda d m [name]

This is not correct, as soda does not offer this functionality (while buffalo-pop does).

The simple fix to this is replacing soda with buffalo pop or buffalo db.

But is it really a good thing to use soda in all the examples and have the explanation to use buffalo pop instead written above every example? I assume it's been this way to provide documentation on pop/soda for people using pop without buffalo, but is this the best place for that? https://gobuffalo.io is the buffalo documentation after all.

Maybe we could use buffalo pop in the examples and extend The Unofficial pop Book or even work on some official documentation/book for pop?

In case we decide for a larger change, changing the destroy documentation might still be a good think for a short term solution.

What do you think?

// cc @gobuffalo/pop-managers @gobuffalo/docs-managers

lukasschlueter avatar Dec 13 '18 10:12 lukasschlueter

Maybe we could use buffalo pop in the examples and extend The Unofficial pop Book or even work on some official documentation/book for pop?

We can't extend The Unofficial pop Book, it's a private project from a person outside the Buffalo org. The original plan was to provide the pop docs in a separate section, then have a section in the buffalo docs for things related only to buffalo's case.

This is not correct, as soda does not offer this functionality (while buffalo-pop does).

Maybe the problem here is just "we should have this feature in soda"? :)

Keep in mind the docs are really a pain to maintain, and the more separate docs we have, the more we have to maintain. Also the idea was to be able to translate the docs, which is not the case with The Unofficial pop Book.

stanislas-m avatar Feb 19 '19 07:02 stanislas-m