Contribution guide update

.github/pull_request_template.md

@@ -8,7 +8,7 @@ Fixes #[insert issue link, if any]
 
 # Writing help
 
-For information about style and word usage, see the [style guide](https://docs.timescale.com/about/latest/contribute-to-docs/)
+For information about style and word usage, see the [Contribution guide](https://github.com/timescale/docs/blob/latest/CONTRIBUTING.md)
 
 # Review checklists
 

README.md

@@ -196,23 +196,23 @@ Where you need the partial to display, insert it as a self-closing tag:
 To maintain consistency, please follow these general rules.
 
 *   Maintain text editor width for paragraphs at 80 characters. We ask you to do
-this to assist in reviewing documentation changes. When text is very wide, it
-is difficult to visually see where text has changed within a paragraph and keeping
-a narrow width on text assists in making PRs easier to review. **Most editors such
-as Visual Studio Code have settings to do this visually.**
+    this to assist in reviewing documentation changes. When text is very wide, it
+    is difficult to visually see where text has changed within a paragraph and keeping
+    a narrow width on text assists in making PRs easier to review. **Most editors such
+    as Visual Studio Code have settings to do this visually.**
 *   Most links should be reference-style links where the link address is at the
-bottom of the page. The two exceptions are:
+    bottom of the page. The two exceptions are:
     *   Links within highlight blocks (Note, Important, or Warning). These must be inline links for now
     *   Links to anchors on the same page as the link itself.
 *   All functions, commands and standalone function arguments (ex. `SELECT`,
-`time_bucket`) should be set as inline code within backticks ("\`command\`").
+    `time_bucket`) should be set as inline code within backticks ("\`command\`").
 *   Functions should not be written with parentheses unless the function is
-being written with arguments within the parentheses.
+    being written with arguments within the parentheses.
 *   "PostgreSQL" is the way to write the elephant database name, rather than
-"Postgres." "TimescaleDB" refers to the database, "Timescale" refers to the
-company.
+    "Postgres." "TimescaleDB" refers to the database, "Timescale" refers to the
+    company.
 *   Use backticks when referring to the object of a user interface action.
-For example: Click `Get started` to proceed with the tutorial.
+    For example: Click `Get started` to proceed with the tutorial.
 
 ### Callout and highlight blocks
 
@@ -264,7 +264,7 @@ Used to indicate an optional step within a procedure. Syntax: `<Optional />`
 Multi-code blocks are code blocks with a language or OS selector. For syntax,
 see [the multi-code-block example](./_multi-code-block.md).
 
-### Tabs 
+### Tabs
 
 Tabs can be used to display content that differs based on a user selection. The
 syntax is:
@@ -329,3 +329,7 @@ There is a specific format for the API section which consists of:
     *   One or two literal examples of the function being used to demonstrate argument syntax.
 
 See the API file to get an idea.
+
+
+
+

_multi-code-block.md

@@ -34,4 +34,4 @@ def different_python:
 
 </tab>
 
-</Terminal>
+</Terminal>

_partials/_deprecated.md

@@ -1,5 +1,7 @@
 <Highlight type="deprecation">
+
 This section describes a feature that is deprecated on Timescale. We strongly
 recommend that you do not use this feature in a production environment. If you
 need more information, [contact us](https://www.timescale.com/contact/).
+
 </Highlight>

_partials/_formatting_examples.md

@@ -0,0 +1,167 @@
+# Formatting examples 
+
+This page illustrates and provides examples of the formatting available for Timescale documentation. Note that for most elements, spacing is important. 
+
+## Procedure
+
+Use for a logical sequence of steps to achieve a goal. For example, create a hypertable.  
+
+![Procedure example](https://assets.timescale.com/docs/images/procedure-syntax.png)
+
+See a [use example][data-tiering] in the docs.
+
+## Highlight blocks
+
+Use sparingly and only if it's essential to attract the reader's attention. 
+
+- Note
+
+    ![Note highlight](https://assets.timescale.com/docs/images/highlight-note.png)
+
+    See a [use example][disable-chunk-skipping] in the docs.
+
+- Important
+
+    ![Important highlight](https://assets.timescale.com/docs/images/highlight-important.png)
+
+    See a [use example][decompress-chunks] in the docs.
+
+- Warning
+
+    ![Caution highlight](https://assets.timescale.com/docs/images/highlight-warning.png)
+
+    See a [use example][alerting] in the docs.
+
+- Deprecation
+
+    ![Deprecated highlight](https://assets.timescale.com/docs/images/highlight-deprecation.png)
+
+    See a [use example][deprecation] in the docs.
+
+- Cloud
+
+    ![Cloud highlight](https://assets.timescale.com/docs/images/highlight-cloud.png)
+
+    Syntax example:
+
+    ```text
+    <Highlight type="cloud">
+
+    A note dealing specifically with Timescale Cloud.
+
+    </Highlight>
+    ```
+
+## Tabs
+
+![Tabs](https://assets.timescale.com/docs/images/tabs-example.png)
+
+See a [use example][live-migration] in the docs.
+
+## Code blocks 
+
+As a default, use [fenced Markdown code blocks][fenced-code-blocks]:
+
+![Regular code block](https://assets.timescale.com/docs/images/markdown-code-block.png)
+
+To remove line numbers and the copy button, use the `CodeBlock` component with `canCopy` and `showLineNumbers` set to `false`:
+
+![Custom code block](https://assets.timescale.com/docs/images/custom-code-block.png)
+
+See a [use example][aggregation] in the docs.
+
+## Multi-tab code blocks
+
+![Multi-tab code block](https://assets.timescale.com/docs/images/multi-tab-code.png)
+
+Syntax example: 
+
+    <Terminal>
+
+    <tab label='ruby'>
+
+    ```ruby
+    ruby code
+    ```
+
+    </tab>
+
+    <tab label="python">
+
+    ```python
+    pyhon code
+    ```
+
+    </tab>
+
+    <tab label="go">
+
+    ```go
+    different python code
+    ```
+
+    </tab>
+
+    </Terminal>
+
+## Tags
+
+- Download
+
+  ![Download tag](https://assets.timescale.com/docs/images/tag-download.png)
+
+  See a [use example][installation-windows] in the docs.
+
+- Experimental
+
+  ![Experimental tag](https://assets.timescale.com/docs/images/tag-experimental.png)
+
+  See a [use example][time-bucket] in the docs.
+
+- Toolkit
+
+  ![Tooklit tag](https://assets.timescale.com/docs/images/tag-toolkit.png)
+
+  See a [use example][time-weighted-average] in the docs.
+
+- Community
+
+  ![Community tag](https://assets.timescale.com/docs/images/tag-community.png)
+
+  See a [use example][remove-reorder-policy] in the docs.
+
+- Hollow
+
+  ![Hollow tag](https://assets.timescale.com/docs/images/hollow-tag.png)
+
+  Syntax example:
+
+  ```text
+  <Tag variant="hollow">Text to display in a tag</Tag>
+  ```
+
+## Partials
+
+Import a partial from the `_partials` directory and then reference it in the relevant part of the page. See a [use example][live-migration] in the docs.
+
+## Links
+
+Links should be [reference-style Markdown links][reference-links]. For example:
+
+[A link to the data tiering section in docs][data-tiering]
+
+[data-tiering]: ../use-timescale/data-tiering/enabling-data-tiering.md
+[disable-chunk-skipping]: ../api/disable_chunk_skipping.md
+[decompress-chunks]: ../use-timescale/compression/decompress-chunks.md
+[alerting]: ../use-timescale/alerting.md
+[deprecation]: ../_partials/_deprecated.md
+[live-migration]: ../migrate/live-migration.md
+[fenced-code-blocks]: https://www.markdownguide.org/extended-syntax/#fenced-code-blocks
+[aggregation]: ../getting-started/test-drive-timescale-features.md
+[installation-windows]: ../self-hosted/install/installation-windows.md
+[time-bucket]: ../api/time_bucket_ng.md
+[time-weighted-average]: ../api/time-weighted-averages.md
+[remove-reorder-policy]: ../api/remove_reorder_policy.md
+[reference-links]: https://www.markdownguide.org/basic-syntax/#reference-style-links
+
+

_procedure-block.md

@@ -16,13 +16,13 @@
   ```
 
 3.  TimescaleDB is a time-series database, built on top of PostgreSQL. More than that,
-however, it's a relational database for time-series. Developers who use TimescaleDB
-get the benefit of a purpose-built time-series database, plus a classic relational
-database (PostgreSQL), all in one, with full SQL support.
+    however, it's a relational database for time-series. Developers who use TimescaleDB
+    get the benefit of a purpose-built time-series database, plus a classic relational
+    database (PostgreSQL), all in one, with full SQL support.
 
   ```python
   def start:
     print('start')
   ```
 
-</Procedure>
+</Procedure>