Skip to content

Commit

Permalink
Word list, glossary, URL fixes, missing descriptions (#304)
Browse files Browse the repository at this point in the history
* AWS Cost explorer

* Word list, glossary, URL fixes, missing descriptions
  • Loading branch information
kimsauce authored Sep 20, 2022
1 parent a5be26e commit 51104c7
Show file tree
Hide file tree
Showing 127 changed files with 418 additions and 501 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Due to the fact that vital metadata (information about the host and its OS) is a

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.

1. In the Sumo Logic web app, select **Manage Data \> Collection \> Collection**.
1. In Sumo Logic, select **Manage Data \> Collection \> Collection**.

1. In the Collectors page, click **Add Source** next to a Hosted Collector.

Expand Down
6 changes: 3 additions & 3 deletions docs/contributing/create-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Create a markdown file with filename.md in a /docs folder that best matches the

## 2. Add doc title and metadata

See [Markdown Features > Front Matter](/docs/contributing/markdown-features#front-matter) to learn how.
See [Markdown Features > Front Matter](/docs/contributing/markdown-cheat-sheet#frontmatter) to learn how.

## 3. Add doc content

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.
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.

### Code of Conduct

Expand Down Expand Up @@ -63,7 +63,7 @@ The `sidebars.ts` file (in repo root) controls the side navigation for the entir
link: {type: 'doc', id: 'contributing/index'},
items: [
'contributing/create-document',
'contributing/markdown-features',
'contributing/markdown-cheat-sheet',
'contributing/release-notes',
'contributing/build-deploy',
'contributing/translations',
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ $ git commit -m "Updating query for metrics"
#### Create a branch

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`
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.
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.

#### Push your changes

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: markdown-features
id: markdown-cheat-sheet
title: Markdown Cheat Sheet
sidebar_label: Markdown Cheat Sheet
description: Learn about markdown features Docusaurus supports.
Expand All @@ -14,9 +14,17 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

This is a guide to writing docs in GitHub-flavored markdown, the language in which our docs are written.

## Front Matter
## What is Markdown?

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.
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 Guide](https://www.markdownguide.org/)
* [Markdown Cheatsheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf)


## Frontmatter

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.

```markdown
---
Expand Down Expand Up @@ -242,7 +250,7 @@ Tables use plain markdown with one header, default left aligned columns, and mul

<TabItem value="Markdown">

```markdown
```
| Column Name | Example Value | Description |
| :-- | :-- | :-- |
| Trace ID | ffaf2f69ee8ad0c1 | The unique identifier of the trace. |
Expand All @@ -255,6 +263,26 @@ Tables use plain markdown with one header, default left aligned columns, and mul
| Status | 200 | The HTTP status code of the trace. |
```


```
Colons can be used to align columns.
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown.
Markdown | Less | Pretty
--- | --- | ---
*Still* | `renders` | **nicely**
1 | 2 | 3
```

</TabItem>
<TabItem value="Result">

Expand All @@ -269,6 +297,28 @@ Tables use plain markdown with one header, default left aligned columns, and mul
| Number of errors | 0 | The number of errors in the trace. |
| Status | 200 | The HTTP status code of the trace. |



Colons can be used to align columns.

| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |

There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown.

Markdown | Less | Pretty
--- | --- | ---
*Still* | `renders` | **nicely**
1 | 2 | 3




</TabItem>
</Tabs>

Expand Down Expand Up @@ -414,11 +464,11 @@ Here's a cool tip.

## Lists

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.
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.

### Numbered Lists

Always start with `1.` for numbered, ordered lists. The generator will automatically number the list correctly when building the site:
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).

```markdown title="Markdown Ordered List"
1. First ordered list item.
Expand Down Expand Up @@ -488,9 +538,12 @@ You can configure your editor to always use this format for lists. For Visual St
* **Ordered List: Marker** set to *one*.
* **Unordered List: Marker** set to *.


## Code Blocks

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).
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.

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.

To highlight lines in the code, use `{#}` in the title line with lines numbers. This example highlights lines 2 through 6.

Expand Down Expand Up @@ -537,7 +590,7 @@ function HelloDocusaurus() {
</TabItem>
</Tabs>

For a full list of options, see [Docusaurus Code Blocks](https://docusaurus.io/docs/markdown-features/code-blocks).
For a full list of options, see [Docusaurus Code Blocks](https://docusaurus.io/docs/markdown-cheat-sheet/code-blocks).

### Import GitHub Repo File

Expand Down
4 changes: 4 additions & 0 deletions docs/contributing/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ id: release-notes
title: Release Notes
---

<head>
<meta name="robots" content="noindex" />
</head>

:::caution

&#128679; Under construction &#128679;
Expand Down
Loading

0 comments on commit 51104c7

Please sign in to comment.