{"id":27933490,"url":"https://github.com/timescale/docs.timescale.com-content","last_synced_at":"2025-05-07T04:59:02.611Z","repository":{"id":46771923,"uuid":"141621252","full_name":"timescale/docs.timescale.com-content","owner":"timescale","description":"Content pages for TimescaleDB documentation","archived":false,"fork":false,"pushed_at":"2025-01-13T17:35:45.000Z","size":2631,"stargazers_count":42,"open_issues_count":40,"forks_count":52,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-07T04:58:56.543Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.timescale.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timescale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-19T19:14:52.000Z","updated_at":"2025-04-28T00:58:43.000Z","dependencies_parsed_at":"2022-09-02T12:11:54.843Z","dependency_job_id":null,"html_url":"https://github.com/timescale/docs.timescale.com-content","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdocs.timescale.com-content","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdocs.timescale.com-content/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdocs.timescale.com-content/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdocs.timescale.com-content/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timescale","download_url":"https://codeload.github.com/timescale/docs.timescale.com-content/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252816943,"owners_count":21808704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-07T04:59:02.107Z","updated_at":"2025-05-07T04:59:02.597Z","avatar_url":"https://github.com/timescale.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# README #\n\n***THIS REPOSITORY IS DEPRECATED. FOR DOCS CHANGES, USE https://github.com/timescale/docs INSTEAD***\n\nThis is the source for content for docs.timescale.com.\nThe docs site uses this repo as a submodule and converts the files directly into\npages using a bash script and markdown parser.\n\nAll files are written in standard markdown.\n\n## Contributing\n\nWe welcome and appreciate any help the community can provide to make\nTimescaleDB's documentation better!\n\nYou can help either by opening an\n[issue](https://github.com/timescale/docs.timescale.com-content/issues) with\nany suggestions or bug reports, or by forking this repository, making your own\ncontribution, and submitting a pull request.\n\nBefore we accept any contributions, Timescale contributors need to\nsign the [Contributor License Agreement](https://cla-assistant.io/timescale/docs.timescale.com-content) (CLA).\nBy signing a CLA, we can ensure that the community is free and confident in its\nability to use your contributions.\n\n## Docs versions\n\nThere is a version of the docs for each supported version of the database, stored in\na separate git branch.  Our docs site parses those branches to allow users to choose\nwhat version of the docs they want to see.  When submitting pull requests, you should determine\nwhat versions of the docs your changes will apply to and attach a label to the pull request\nthat denotes the earliest version that your changes should apply to (`0.9`, `0.10`, `1.0`, etc.)\nThe admin for the docs will use that as a guide when updating version branches.\n\n### A note on page links\n\nNone of the internal page links within these files will work on GitHub.  They are designed to function within the code for the documentation site at [docs.timescale.com](http://docs.timescale.com).  All external links should work.\n\n### A note on anchors\n\nIf you want to link to a specific part of the page from the docs sidebar, you\nneed to place a special anchor `[](anchor_name)`.\n\n**Your anchor name must be unique** in order for the highlight scrolling to work properly.\n\n### A note on code blocks\nWhen showing commands being entered from a command line, do not include a\ncharacter for the prompt.  Do this:\n\n```bash\nsome_command\n```\n\ninstead of this:\n```bash\n$ some_command\n```\n\nor this:\n```bash\n\u003e some_command\n```\n\nOtherwise the code highlighter may be disrupted.\n\n### General formatting conventions\n\nTo maintain consistency, please follow these general rules.\n1. Make sure to add line breaks to your paragraphs so that your PRs are readable\nin the browser.\n1. All links should be reference-style links where the link address is at the\nbottom of the page.  The only exceptions are links to anchors on the same page\nas the link itself.\n1. All functions, commands and standalone function arguments (ex. `SELECT`,\n`time_bucket`) should be set as inline code within backticks (\"\\`command\\`\").\n1. Functions should not be written with parentheses unless the function is\nbeing written with arguments within the parentheses.\n1. \"PostgreSQL\" is the way to write the elephant database name, rather than\n\"Postgres\".  \"TimescaleDB\" refers to the database, \"Timescale\" refers to the\ncompany.\n1. Use single quotes when referring to the object of a user interface action.\nFor example: Click 'Get started' to proceed with the tutorial.\n\n### Special rules\nThere are some custom modifications to the markdown parser to allow for special\nformatting within the docs.\n\n+ Adding `sss ` to the start of every list item in an ordered list will result in\n  a switch to \"steps\" formatting which is used to denote instructional steps, as\n  for a tutorial.\n+ Adding `\u003e:TIP: ` to the start of a blockquote (using '\u003e') will create a \"tip\" callout.\n+ Adding `\u003e:WARNING: ` to the start of a blockquote (using '\u003e') will create a \"warning\" callout.\n+ Adding `\u003e:TOPLIST: ` as the first line of a blockquote (using '\u003e') will\ncreate a fixed right-oriented box, useful for a table of contents or list of\nfunctions, etc.  See the FAQ page (faq.md) for an example.\n    - The first headline in the toplist will act as the title and will be separated from the remainder of the content stylewise (on the FAQ page, it's the headline \"Questions\").\n    - Everything else acts as a normal blockquote does.\n+ Adding a text free link to a header with a text address (Ex. `## Important Header [](indexing)`) will create an anchor icon that links to that header with the hash name of the text.\n+ Adding `:FOOTER_LINK: ` to the start of a paragraph(line) will format it as a \"footer link\".\n+ Adding `:DOWNLOAD_LINK: ` to the start of a link will append a 'download link' icon to the end of the link inline.\n+ Adding `x.y.z` anywhere in the text will be replaced by the version number of the branch.  Ex. `look at file foo-x.y.z` \u003e\u003e `look at file foo-0.4.2`.\n+ Adding `:pg_version:` to text displayed in an installation section (i.e. any page with a filename beginning `installation-`) will display the PostgreSQL version number.  This is primarily to be used for displayed filenames in install instructions that need to be modular based on the version.\n+ Designating functions\n    + Adding `:community_function:` to a header (for example, in the api section) adds decorator text \"community function\".\n\n_Make sure to include the space after the formatting command!_\n\n**Warning**: Note the single space required in the special formats before adding\nnormal text. Adding ':TIP:' or ':WARNING:' to the start of any standard paragraph will\nresult in non-optimal html.  The characters will end up on the outside of the\nparagraph tag.  This is due to the way that the markdown parser interprets\nblockquotes with the new modifications.\nThis will be fixed in future versions if it becomes a big issue, but we don't\nanticipate that.\n\n### Editing the API section\n\nThere is a specific format for the API section which consists of:\n- **Function name** with empty parentheses (if function takes arguments). Ex. `add_dimension()`\n- A brief, specific description of the function\n- Any warnings necessary\n- **Required Arguments**\n    - A table with columns for \"Name\" and \"Description\"\n- **Optional Arguments**\n    - A table with columns for \"Name\" and \"Description\"\n- Any specific instructions about the arguments, including valid types\n- **Sample Usage**\n    - One or two literal examples of the function being used to demonstrate argument syntax.\n\nSee the API file to get an idea.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Fdocs.timescale.com-content","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimescale%2Fdocs.timescale.com-content","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Fdocs.timescale.com-content/lists"}