Skip to content

Commit

Permalink
Procedure styling jacob (github#515)
Browse files Browse the repository at this point in the history
* update

* add procedure block instructions

* convert styling to procedrue on cloud/disk management

* Apply suggestions from code review

Co-authored-by: Lana Brindley <[email protected]>

Co-authored-by: Lana Brindley <[email protected]>
  • Loading branch information
jacobprall and Loquacity authored Oct 12, 2021
1 parent 4ef78af commit c14b3cf
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 4 deletions.
28 changes: 28 additions & 0 deletions _procedure-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<procedure>

### Procedure Title

1. Do this

```bash
code code code
```

2. Then do this

```ruby
def function
print('hello')
```

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.

```python
def start:
print('start')
```

</procedure>
11 changes: 9 additions & 2 deletions cloud/disk-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ You can only increase your service's storage once every six hours, and you canno
currently decrease your storage size once set.
</highlight>

### Procedure: Increasing service resources
<procedure>

### Increasing service resources
1. In the Timescale Cloud console, navigate to `Services` and click the service
you want to adjust. Navigate to the `Operations` tab, and go to the `Resources`
section.
Expand All @@ -78,6 +80,8 @@ and you can begin writing data immediately.

<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/tsc-resources-changed.png" alt="Timescale Cloud change resources"/>

</procedure>

## Storage recovery

If you need to perform actions on your database to reduce your data usage, you
Expand All @@ -91,7 +95,9 @@ increasing the disk size before you do this. Alternatively, you can enable
read-write access on an individual session, while leaving the database in
read-only mode. </highlight>

### Procedure: Enabling read-write access on an individual session
<procedure>

### Enabling read-write access on an individual session
1. Connect to your database using `psql` and turn off read-only protection
for the current session:
```sql
Expand All @@ -111,5 +117,6 @@ read-only mode. </highlight>
SELECT add_compression_policy('<table_name>', interval '1 day');
```

</procedure>
As soon as the storage consumption drops below the threshold, the read-only
protection is automatically removed, and you can start writing data again.
8 changes: 6 additions & 2 deletions timescaledb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ to successfully use and implement all of the powerful features for your next
project.

### Overview

In the **[Overview section][overview]** you'll find everything you need to know about the design
and core concepts that make TimescaleDB the super powered, time-series database
that it is.
Expand All @@ -19,6 +20,7 @@ You'll also find [Release Notes][release-notes], our [FAQ][faq], and any [known
current version of TimescaleDB that you should be aware of.

### Getting started

The **[Getting started tutorial][getting-started]** will lead you through your first experience with
TimescaleDB by setting up hypertables, importing data, running queries, and
exploring the key features that make TimescaleDB a pleasure to use.
Expand All @@ -27,11 +29,13 @@ If you've never used TimescaleDB or haven't explored many of our features yet,
this is the place to start.

### How-to guides

Our **[How-to guides][how-to]** provide answers to common questions with each feature
of TimescaleDB. Using hypertables, enabling native compression, setting up data retention,
and much more are all covered here.

### Tutorials

**[TimescaleDB tutorials][tutorials]** is an ever-growing list of new long-form guides
to help you setup a project from beginning to end in order to explore features of
TimescaleDB in more depth.
Expand All @@ -41,11 +45,11 @@ and Promscale][promscale], a 💯 series of [Grafana examples][grafana], [analyz
and more.

### Code quick starts
In our **[Code quick starts][code]** section we provide samples of connecting to

In our **[Code quick starts][code]** section we provide samples of connecting to
TimescaleDB from a growing list of application languages using standard SDKs
and best practices.


[overview]: /overview/
[release-notes]: /overview/release-notes/
[faq]: /overview/faq/
Expand Down

0 comments on commit c14b3cf

Please sign in to comment.