Add excerpts for TimescaleDB sections (github#276)

* Add metadata for howto index (to L322)

* Update to new format

* remove old tags

* remove unnecessary page components, format

* add array to old metadata tag

* fix titles, remove extra page components, add more descriptive titles to source pages

* typo fix

* typo fix

* Add some more metadata

* All the rest \o/

* remove mentions of mst

* fix typo

* change excerpts from arrays to strings

* add excerpts

* remove metaTags

* add excerpts to overview section

* add excerpts for tutorials

* add link rules to read me

* spacing

* update entry

* remove update search index for now

Co-authored-by: loquacity <github@lanabrindley.com>

README.md

@@ -141,12 +141,27 @@ None of the internal page links within these files will work on GitHub inside of
 the raw Markdown files that are being reviewed. Instead, the review link discussed
 above should be utilized for verifying all internal links.
 
-All external links should work.
+Links should be formatted according to their target.
+
+### External links:
+
+Input as-is.
+
+### Internal links pointing to urls outside the current page's product and/or version:
+
+The link used does not need to include https://docs.timescale.com/, but should contain 
+the appropriate product and version. 
+
+### Internal links pointing to urls within the same product and version:
+
+The link does not require the current product and version. If a product is used
+in the url, there must be an accompanying version.
 
 ### Anchor tags
 
 By default, any H2 or H3 heading ('##' and '###' respectively in Markdown) will
-have an anchor tag generated automatically.
+have an anchor tag generated automatically. You can set the anchor and table of 
+contents text by using `[custom_table_of_contents_label](custom_anchor_tag)`
 
 If you want to link to a specific part of the page elsewhere in your document, you
 need to use special anchor Markdown next to your anchor text; eg. `[](anchor_name)`.

timescaledb/getting-started/page-index/page-index.js

@@ -6,39 +6,48 @@ module.exports = [
         children: [
           {
             title: "1. Launch your first instance",
-            href: "launch-timescaledb"
+            href: "launch-timescaledb",
+            excerpt: "Use Timescale Forge to launch your first TimescaleDB instance"
           },
           {
             title: "2. Access your database",
             href: "access-timescaledb",
+            excerpt: "Connect to your database using psql"
           },
           {
             title: "3. Create a hypertable",
-            href: "create-hypertable"
+            href: "create-hypertable",
+            excerpt: "Create a hypertable in TimescaleDB"
           },
           {
             title: "4. Add time-series data",
-            href: "add-data"
+            href: "add-data",
+            excerpt: "Add sample data to your TimescaleDB instance"
           },
           {
             title: "5. Query your data",
-            href: "query-data"
+            href: "query-data",
+            excerpt: "Query your data using full SQL in TimescaleDB"
           },
           {
             title: "6. Create a continuous aggregate",
-            href: "create-cagg"
+            href: "create-cagg",
+            excerpt: "Establish continuous aggregates in TimescaleDB"
           },
           {
             title: "7. Save space with compression",
-            href: "compress-data"
+            href: "compress-data",
+            excerpt: "Use TimescaleDB's native compression to save space"
           },
           {
             title: "8. Learn about data retention",
-            href: "data-retention"
+            href: "data-retention",
+            excerpt: "Create a database retention policy for your TimescaleDB instance"
           },
           {
             title: "9. Next steps",
-            href: "next-steps"
+            href: "next-steps",
+            excerpt: "Learn how to migrate, visualize and connect your data to TimescaleDB"
           }
         ]
       }