You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Due to the fact that vital metadata (information about the host and its OS) is a
30
30
31
31
Installation steps require you to add a Source to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.
32
32
33
-
1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.
33
+
1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.
34
34
35
35
1. In the Collectors page, click **Add Source** next to a Hosted Collector.
Copy file name to clipboardExpand all lines: docs/contributing/create-document.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,11 +20,11 @@ Create a markdown file with filename.md in a /docs folder that best matches the
20
20
21
21
## 2. Add doc title and metadata
22
22
23
-
See [Markdown Features > Front Matter](/docs/contributing/markdown-features#front-matter) to learn how.
23
+
See [Markdown Features > Front Matter](/docs/contributing/markdown-cheat-sheet#frontmatter) to learn how.
24
24
25
25
## 3. Add doc content
26
26
27
-
See [Markdown Cheat Sheet](markdown-features.md) to learn about how to write in markdown. Doc body text content is written in GitHub-flavored markdown, with some customizations.
27
+
See [Markdown Cheat Sheet](markdown-cheat-sheet.md) to learn about how to write in markdown. Doc body text content is written in GitHub-flavored markdown, with some customizations.
28
28
29
29
### Code of Conduct
30
30
@@ -63,7 +63,7 @@ The `sidebars.ts` file (in repo root) controls the side navigation for the entir
1. Create a new branch from your cloned repo/fork using a name that best describes the work or references a GitHub issue number. For example: `<your initials>-tracing-update` or `<your initials>-apps-gitlab`
93
-
1. Edit or create markdown (.md) files in your branch. See [Create a Document](create-document.md) and [Markdown Features](markdown-features.md) for more info.
93
+
1. Edit or create markdown (.md) files in your branch. See [Create a Document](create-document.md) and [Markdown Features](markdown-cheat-sheet.md) for more info.
Copy file name to clipboardExpand all lines: docs/contributing/markdown-cheat-sheet.md
+61-8Lines changed: 61 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
id: markdown-features
2
+
id: markdown-cheat-sheet
3
3
title: Markdown Cheat Sheet
4
4
sidebar_label: Markdown Cheat Sheet
5
5
description: Learn about markdown features Docusaurus supports.
@@ -14,9 +14,17 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
14
14
15
15
This is a guide to writing docs in GitHub-flavored markdown, the language in which our docs are written.
16
16
17
-
## Front Matter
17
+
## What is Markdown?
18
18
19
-
Markdown documents have metadata at the top called [front matter](https://jekyllrb.com/docs/front-matter/). Every page should have an `id` used for sidebar navigation.
19
+
Markdown is a simple, text-based format you can write using text editors, IDEs, or the GitHub website to write content. We use Docusaurus to manage, style, and build our site. We use GitHub-flavored Markdown with some additional options. Here are more guides and options:
Markdown documents have metadata at the top called [frontmatter](https://jekyllrb.com/docs/front-matter/). Every page should have an `id` used for sidebar navigation.
20
28
21
29
```markdown
22
30
---
@@ -242,7 +250,7 @@ Tables use plain markdown with one header, default left aligned columns, and mul
242
250
243
251
<TabItemvalue="Markdown">
244
252
245
-
```markdown
253
+
```
246
254
| Column Name | Example Value | Description |
247
255
| :-- | :-- | :-- |
248
256
| Trace ID | ffaf2f69ee8ad0c1 | The unique identifier of the trace. |
@@ -255,6 +263,26 @@ Tables use plain markdown with one header, default left aligned columns, and mul
255
263
| Status | 200 | The HTTP status code of the trace. |
256
264
```
257
265
266
+
267
+
```
268
+
Colons can be used to align columns.
269
+
270
+
| Tables | Are | Cool |
271
+
| ------------- |:-------------:| -----:|
272
+
| col 3 is | right-aligned | $1600 |
273
+
| col 2 is | centered | $12 |
274
+
| zebra stripes | are neat | $1 |
275
+
276
+
There must be at least 3 dashes separating each header cell.
277
+
The outer pipes (|) are optional, and you don't need to make the
278
+
raw Markdown line up prettily. You can also use inline Markdown.
279
+
280
+
Markdown | Less | Pretty
281
+
--- | --- | ---
282
+
*Still* | `renders` | **nicely**
283
+
1 | 2 | 3
284
+
```
285
+
258
286
</TabItem>
259
287
<TabItemvalue="Result">
260
288
@@ -269,6 +297,28 @@ Tables use plain markdown with one header, default left aligned columns, and mul
269
297
| Number of errors | 0 | The number of errors in the trace. |
270
298
| Status | 200 | The HTTP status code of the trace. |
271
299
300
+
301
+
302
+
Colons can be used to align columns.
303
+
304
+
| Tables | Are | Cool |
305
+
| ------------- |:-------------:| -----:|
306
+
| col 3 is | right-aligned | $1600 |
307
+
| col 2 is | centered | $12 |
308
+
| zebra stripes | are neat | $1 |
309
+
310
+
There must be at least 3 dashes separating each header cell.
311
+
The outer pipes (|) are optional, and you don't need to make the
312
+
raw Markdown line up prettily. You can also use inline Markdown.
313
+
314
+
Markdown | Less | Pretty
315
+
--- | --- | ---
316
+
*Still* | `renders` | **nicely**
317
+
1 | 2 | 3
318
+
319
+
320
+
321
+
272
322
</TabItem>
273
323
</Tabs>
274
324
@@ -414,11 +464,11 @@ Here's a cool tip.
414
464
415
465
## Lists
416
466
417
-
You can mix ordered (or numbered) and unordered (or bulleted) lists together. Use extra lines and tabs (or 2 spaces) to move content under these bullets, including other bullets, paragraphs, images, and more. Be careful of tabbing over too far. A third tab will automatically render as code.
467
+
You can mix ordered (or numbered) and unordered (or bulleted) lists together. Use extra lines and tabs (or 2 spaces) to move content under these bullets, including other bullets, paragraphs, images, and more. Be careful of tabbing over too far. A third tab will automatically render as code.
418
468
419
469
### Numbered Lists
420
470
421
-
Always start with `1.` for numbered, ordered lists. The generator will automatically number the list correctly when building the site:
471
+
Always start with `1.` for numbered, ordered lists. The generator will automatically number the list correctly when building the site. This can be helpful when you need to add or change the order of instructions (no need to edit every number).
422
472
423
473
```markdown title="Markdown Ordered List"
424
474
1. First ordered list item.
@@ -488,9 +538,12 @@ You can configure your editor to always use this format for lists. For Visual St
488
538
***Ordered List: Marker** set to *one*.
489
539
***Unordered List: Marker** set to *.
490
540
541
+
491
542
## Code Blocks
492
543
493
-
Markdown code blocks are supported with Syntax highlighting. Always use [code block](#code-blocks) to format programming language (i.e., SQL for Sumo queries, JSON for logs).
544
+
Always use [code block](#code-blocks) to format programming language scripts (i.e., SQL for Sumo queries, JSON for logs). Format blocks of code by placing triple backticks before and after the code.
545
+
546
+
Markdown code blocks support Syntax highlighting. If you know the code language, include that in the first set of ticks. This applies code highlighting for the language. See [this list](https://prismjs.com/#supported-languages) of available languages.
494
547
495
548
To highlight lines in the code, use `{#}` in the title line with lines numbers. This example highlights lines 2 through 6.
496
549
@@ -537,7 +590,7 @@ function HelloDocusaurus() {
537
590
</TabItem>
538
591
</Tabs>
539
592
540
-
For a full list of options, see [Docusaurus Code Blocks](https://docusaurus.io/docs/markdown-features/code-blocks).
593
+
For a full list of options, see [Docusaurus Code Blocks](https://docusaurus.io/docs/markdown-cheat-sheet/code-blocks).
0 commit comments