Docs Standards and Procedures (Page)

[smolinari]

Hi,

This should be a draft (and seen as a suggestion) and discussion for doc standards and contribution procedures.

Standards

---

1. ALL SQL statements must be in capitalized letters.**

For instance....

insert into TestLineSTring set name = 'Test1' , location = St_GeomFromText("LINESTRING(0 0, 3 3)")

should be

INSERT INTO TestLineSTring SET name = 'Test1' , location = St_GeomFromText("LINESTRING(0 0, 3 3)")

2. ALL "For more information see:" sections must be in a quote block.

Use ">" to add the quote block. Multiple links should be in an unordered list.

Example:

For more information see:

• Item 1
• Item 2

  2.1 Links to commands should be placed in "code" blocks with back ticks "`".

Example:

For more information, see

• Transactions
• BEGIN
• ROLLBACK
• Console Commands

Notice the BEGIN and ROLLBACK commands.

Procedures

---

Authoring and Editing

In order to become an author or editor of the documentation, you'll need a Github account.

To make additions or changes do the following:

• Yadda, yadda, yadda

Proofreading

If you proofread either for technical purposes or for grammatical reasons, you MUST add an html comment at the top of the file like so.

`'

Where, "XXX" is the initials to your name. This will indicate the file was corrected and when and should avoid double work. It can also help with general changes to doc standards, should there be any.

---

Please add any additional information in posts below. I'll add them and then make the document and add them to the docs.

Scott

[smolinari]

Made some updates.

Scott

[smolinari]

Another update.

Added a formatting rule of "For more information" section.

Scott