{"id":15137835,"url":"https://github.com/logzio/logz-docs","last_synced_at":"2025-10-23T13:31:02.116Z","repository":{"id":37450978,"uuid":"135286803","full_name":"logzio/logz-docs","owner":"logzio","description":"Logz.io user documentation","archived":false,"fork":false,"pushed_at":"2023-12-12T15:40:11.000Z","size":24589,"stargazers_count":16,"open_issues_count":29,"forks_count":42,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-01-30T18:48:21.633Z","etag":null,"topics":["documentation","elasticsearch","elk-stack","grafana","grafana-prometheus","jaeger","jaeger-tracing","jaegertracing","kibana","logstash","logzio","open-telemetry"],"latest_commit_sha":null,"homepage":"https://docs.logz.io","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/logzio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-29T11:35:46.000Z","updated_at":"2023-10-20T05:29:03.000Z","dependencies_parsed_at":"2023-10-12T23:08:50.629Z","dependency_job_id":"5b345e91-c9a9-42f8-9ffc-a4149e891c1f","html_url":"https://github.com/logzio/logz-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logzio%2Flogz-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logzio%2Flogz-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logzio%2Flogz-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logzio%2Flogz-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/logzio","download_url":"https://codeload.github.com/logzio/logz-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237834620,"owners_count":19373759,"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":["documentation","elasticsearch","elk-stack","grafana","grafana-prometheus","jaeger","jaeger-tracing","jaegertracing","kibana","logstash","logzio","open-telemetry"],"created_at":"2024-09-26T07:02:32.012Z","updated_at":"2025-10-23T13:30:55.535Z","avatar_url":"https://github.com/logzio.png","language":"JavaScript","readme":"\u003cimg width=\"200\" src=\"_source/images/logo/logz-logo.svg\"\u003e\n\n# Logz.io Docs \u0026nbsp; \u0026nbsp; [![Netlify Status](https://api.netlify.com/api/v1/badges/3a2c5e61-7e63-4058-8825-619c89323f95/deploy-status)](https://app.netlify.com/sites/logz-docs/deploys)\n\nWelcome to the source repo for Logz.io Docs!\n\nOur site is built on Jekyll.\nDocs are continuously deployed to docs.logz.io from `master`.\n\n#### Contents\n\n* [Contributions](#contributions)\n  * [What pull requests we can't merge](#what-pull-requests-we-cant-merge)\n  * [Community guidelines](#community-guidelines)\n* [Setup](#setup)\n* [Changes and pull requests](#changes-and-pull-requests)\n  * [Syncing your fork](#syncing-your-fork)\n  * [Previewing locally](#previewing-locally)\n  * [Making your first pull request](#making-your-first-pull-request)\n* [Working in Markdown](#working-in-markdown)\n  * [The basics](#the-basics)\n  * [Headings](#headings)\n  * [Procedures](#procedures)\n  * [Info boxes](#info-boxes)\n  * [Code highlighting](#code-highlighting)\n* [Credits and contributors](#credits-and-contributors)\n  * [Open source software used in Docs](#open-source-software-used-in-docs)\n\n## Contributions\n\nPlease follow the [Setup](#setup) instructions so you can start.\n\nMake all pull requests to the `master` branch.\n\nIf you just want to submit a quick edit suggestion, you can [open an issue](https://github.com/logzio/logz-docs/issues/new?template=docs-issue.md).\n\nPlease [preview](#previewing-locally) your changes locally before submitting pull requests.\n\n### What pull requests we can't merge\n\nWe need to reject any pull requests that include these changes:\n\n* Changes to our OpenAPI file\n* Changes to our config file\n* Changes to another contributor's information\n\nIf you want to suggest a change or report an error in any of these files, please [open an issue](https://github.com/logzio/logz-docs/issues/new?template=docs-issue.md).\n\nWe might decline a pull request for another reason,\nbut usually we just ask some follow-up questions and request small changes.\n\n### Community guidelines\n\nPlease review the [Logz.io Community Code of Conduct](CODE_OF_CONDUCT.md)\n\n## Setup\n\nIf you haven't contributed to the Logz.io Docs before, follow these steps to get started.\n\n[Join GitHub](https://github.com/join) if you don't already have an account.\n\n**Install dependencies**:\n\n1. [Git](https://help.github.com/articles/set-up-git/)\n\n2. macOS: [Xcode](https://apps.apple.com/il/app/xcode/id497799835?mt=12)\n\n3. macOS: Xcode command line tools: `xcode-select --install`.\n\n4. macOS: [Homebrew](https://brew.sh/): `/usr/bin/ruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"`\n\n5. [RVM with Ruby](https://rvm.io/rvm/install): `curl -sSL https://get.rvm.io | bash -s stable --ruby`\n\n6. [Bundler](https://bundler.io/): `sudo gem install bundler`\n\n7. [Node and npm](https://www.npmjs.com/get-npm):\n  Check that they're installed (`node -v`, `npm -v`).\n  If not, [download Node.js](https://nodejs.org/en/).\n  (npm is installed as part of Node.js).\n\n8. [Fork](https://github.com/logzio/logz-docs/fork) the logz-docs repository\n\n9. Clone your fork and add logzio/logz-docs as your upstream repo:\n\n    ```shell\n    git clone https://github.com/\u003cyour_github\u003e/logz-docs.git\n    cd logz-docs\n    git remote add upstream https://github.com/logzio/logz-docs.git\n    git fetch upstream\n    ```\n\n11. Install Jekyll and logz-docs dependencies:\n  `sudo bundle install`,\n  `npm install`\n\n## Changes and pull requests\n\nWe use `master` as the main branch.\nOur site deploys every time we merge to `master`.\n\nFor you, this means that you should create new branches and make your changes there.\nYou should also regularly sync your fork with the upstream repo (logzio/logz-docs) so that we can merge your changes without any problems.\n\nSo the ideal process looks a little like this:\n\n[Sync](#syncing-your-fork) ➜ New branch ➜ Changes ➜ [Preview](#previewing-locally) ➜ Push ➜ [Pull request](#making-your-first-pull-request)\n\n### Syncing your fork\n\nKeeping your fork up to date allows us to easily merge your changes.\nThis is a pretty simple process.\n\n**To sync your fork**:\n\n1. Open a terminal window and `cd` into your logz-docs folder.\n\n2. Checkout your local `master` branch, pull the logzio/logz-docs `master` branch, and push the updates to your fork:\n\n    ```shell\n    git checkout master\n    git pull upstream master\n    git push\n    ```\n\n### Previewing locally\n\nBefore submitting pull requests, preview your changes locally.\nThis does a few things to help you catch mistakes:\n\n* Seeing the formatted text, outside of a text editor and without all the markup, gives you a fresh look at your content.\n* You can be sure that your Markdown is formatted correctly and converts to HTML just as you meant it to.\n\nPlease check your work for errors and readability.\n\n**To preview locally**:\n\n1. Run `./preview.sh`.\n\n2. Point your browser to [http://localhost:4000/](http://localhost:4000/).\n  (Don't worry about the ducks.\n  They're just there to tell you this is a local preview and not on the web.)\n\n### Making your first pull request\n\nWe like to give contributors credit for their work, so go ahead and add yourself as a contributor in your first pull request.\n\n**To add yourself as a contributor**:\n\n1. Find the contributors folder on your machine at `logz-docs/_source/logzio_collections/_contributors`.\n  Add a new Markdown file, named `\u003cyour-github-username\u003e.md`. \\\n  So if your GitHub username is agrant, your file is named `agrant.md`. This is your identifier when you contribute to docs.\n\n2. Copy this YAML content to the file, and add your information.\n  If something doesn't apply to you, delete the line that doesn't apply:\n\n    ```yaml\n    ---\n    title: \u003cyour name\u003e\n    website: \u003cyour website url\u003e\n    linkedin: \u003cyour linkedin username\u003e\n    twitter: \u003cyour twitter handle\u003e\n    github: \u003cyour github username\u003e\n    ---\n    ```\n\n    Don't add any other content to the file.\n\n3. Save and commit.\n\n4. Include this file in your first pull request.\n  If you're authoring a file, add your identifier (GitHub username) to the `contributors` list. \\\n  So if your username is chaostheory, you'll add `- chaostheory` to the file's `contributors` list.\n\n## Working in Markdown\n\nLogz.io Docs use kramdown-flavored Markdown. Where possible, avoid HTML tags.\n\nSome notes:\n\n* Leave a blank line between text blocks.\n* Indents are two spaces (not tabs).\n  To nest blocks in a list, indent twice (four spaces). This keeps nested items from breaking a list.\n* You _can_ put Markdown formatting in an HTML container, but please preview your code locally to make sure nothing unexpected is happening with the HTML conversion.\n\n### The basics\n\n````markdown\n**bold**\n\n_italic_\n\n`inline code`\n\n```\nfenced\ncode\nblock\n```\n\n\u003c!-- For a link that opens in the same tab --\u003e\n[Link placeholder](https://url.com/)\n\n\u003c!-- For alink to open in a new tab --\u003e\n\u003ca href=\"https://url.com/\" target=\"_blank\"\u003eLink placeholder\u003c/a\u003e\n\n![Image alt text](/url/of/image.png)\n\n[![Linked image](/url/of/image.png)](https://target.link/page.html)\n\n* unordered list\n* list item 2\n* list item 3\n\n\u003c!-- This is Kramdown-specific and probably won't work with other Markdown flavors --\u003e\nTerm 1\n: Definition 1\n\nTerm 2\n: Definition 2\n\n\n| Table heading | Table heading 2 |\n|---|---|\n| Table body 1 | Table body 2 |\n| Table body 3 | Table body 4 |\n````\n\n### Headings\n\n* Our template reserves `#` (h1) for page titles.\n* Use `##` and `###` (h2 and h3) for normal headings.\n* Use `####` through `######` (h4 through h6) are reserved for procedures.\n\n### Procedures\n\n* We don't have a strict style for procedures,\n  except to make them as simple as possible.\n* Avoid long procedures.\n  If your procedure has more than 10 high-level steps,\n  shorten it, or break it apart into multiple procedures.\n\n\n\n````md\n#### Procedure title\n\n**Before you begin, you'll need**:\nA list of prerequisites,\nSome of them with [links](#) to external docs,\nIf applicable\n\n\u003c!-- 👇 This gives the necessary CSS --\u003e\n\u003cdiv class=\"tasklist\"\u003e\n\n##### Step 1 headline\n\nBody text.\n\nKeep it short.\n\n##### Step 2 headline\n\nYou don't need to add numbers to the steps.\nThe CSS will take care of all that.\n\nInclude code blocks in fenced backticks...\n\n```py\n...like this one\n```\n\n###### Parameters\n\n☝ H6 are used for subheads within the procedure.\nParameter lists are always introduced with a subhead.\n\n| Parameter | Description |\n|---|---|\n| param1 \u003cspan class=\"required-param\"\u003e\u003c/span\u003e | Include this span if parameter is required. Required params are always at the top of the list, with rare exception. |\n| param2 \u003cspan class=\"default-param\"\u003e`\"default value\"`\u003c/span\u003e | If there's a default, include it here. \u003cbr\u003e If you need a line break, hard code it. |\n{:.paramlist}\n\n☝ Add `{:.paramlist}` to the end of parameter tables so they're formatted properly.\nUse the `\u003cbr\u003e` tag for a hard line break.\n\n`.paramlist` tables must always be two columns.\n\n\u003c/div\u003e\n\n````\n\n### Info boxes\n\nInfo boxes need to live in their own text blocks and are followed by a kramdown attribute string: `{:.info-box.\u003ckind_of_note\u003e}`\n\nInfo boxes come in these CSS classes: `note`, `tip`, `important`, `warning`, `read`.\nCSS handles the styling and adds a header.\n\n**Notes**\n\n```\nNotes are generally non-actionable. They’re more important\nthan the surrounding text but less important than\nwarnings. Could something bad happen if the user ignores\nthis? If no, then it’s a note. Otherwise, it’s an important note.\n{:.info-box.note}\n```\n\n**Tips**\n\n```\nPro tips convey best practices and good actions to ensure success.\nThink of these as more proactive than important notes.\n{:.info-box.tip}\n```\n\n**Important notes**\n\n```\nImportant notes help the user work through common trip-up points.\nIf the user could cause damage by ignoring the important note,\nconsider a warning instead.\n{:.info-box.important}\n```\n\n**Warnings**\n\n```\nUse warnings when the user could cause damage that’s\ndifficult or impossible to recover from. If you need\nsomething less severe than a warning, consider an important note\nor a note.\n{:.info-box.warning}\n```\n\n### Code highlighting\n\nSurround inline code samples with a single backtick: `` `code sample` ``\n\nJekyll supports syntax highlighting for code blocks if you say what the code actually is.\n\nFor example, for HTML:\n\n````html\n```html\n\u003ci class=\"fas fa-dove\"\u003e\u003c/i\u003e\n```\n````\n\n## Git branch groups\n\n_For the Logz.io docs team_:\nHere's a list of branch groups that we should use\nto clarify what we're working on.\n\n* api\n* shipping\n* ui\n* docs-tooling\n* docs-misc\n* integrations\n\n## Credits and contributors\n\nWe invite contributions to docs, and we maintain a [list of contributors](https://docs.logz.io/credits.html) at the Logz.io Docs site.\n\n### Open source software used in Docs\n\n* [clipboard.js](https://clipboardjs.com/)\n* [Easytabs](https://os.alfajango.com/easytabs/)\n* [Font Awesome 5 Free](https://fontawesome.com/)\n* [GitHub Octicons](https://github.com/primer/octicons/)\n* [Jekyll](https://jekyllrb.com/)\n* [jQuery](https://jquery.com/) and [jQuery UI](https://jqueryui.com/)\n* [Lunr](https://lunrjs.com/)\n* [tablesorter](http://tablesorter.com/docs/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogzio%2Flogz-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flogzio%2Flogz-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogzio%2Flogz-docs/lists"}