iodepo / odis-arch

Development of the Ocean Data and Information System (ODIS) architecture
https://book.odis.org/
29 stars 17 forks source link

Create gettingStarted.md #380

Closed pbuttigieg closed 3 months ago

pbuttigieg commented 8 months ago

Changes for #379

pbuttigieg commented 8 months ago

@fils Was this the placeholder for the getting started guide?

https://github.com/iodepo/odis-arch/blob/8bc09bdaf517f91eec6289f15438da67482c19df/book/_toc.yml#L15-L17

Are we defaulting to camelCase or snake-case?

jmckenna commented 4 months ago

Are we defaulting to camelCase or snake-case?

camelCase is preferred (we should be consistent throughout all of our repos).

However this PR is confusing, as it there is a nicely formatted (and nicely named) gettingStarted.md (notice also the correct lowercase of the extension) in the root of the book directory. Whereas this PR here has an oddly named directory and oddly named file, and leaves the other gettingStarted.md file as-is in the root.

Let's discuss this in the meeting Wednesday.

jmckenna commented 4 months ago

Answering my own comments here: I'll use this PR and update it, so it makes the changes into the existing gettingStarted.md file.

jmckenna commented 4 months ago

Aside: Let me know where to add these notes, for documentation rules in our repository:

fils commented 3 months ago

Ready for merge