Skip to content

Commit 67552ea

Browse files
committed
Add images to contributing
1 parent a66dc7f commit 67552ea

File tree

2 files changed

+9
-30
lines changed

2 files changed

+9
-30
lines changed

docs/contributing/style-guide.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -894,7 +894,7 @@ Always start with `1.`. Markdown automatically numbers sequentially when buildin
894894
1. Ordered sub-list.
895895
1. And another item.
896896
897-
More content for this entry. And a screenshot:<br/> ![span hover](/img/apm/span-hover-view.png)
897+
More content for this entry. And a screenshot:<br/><img src={useBaseUrl('img/apm/span-hover-view.png')} alt="Span hover" style={{border: '1px solid gray'}} width="400" />
898898
899899
```
900900
</TabItem>
@@ -906,7 +906,7 @@ Always start with `1.`. Markdown automatically numbers sequentially when buildin
906906
1. Actual numbers do not matter, just that it is a number.
907907
1. Ordered sub-list.
908908
1. And another item.
909-
* More content for this entry. And a screenshot:<br/> ![span hover](/img/apm/span-hover-view.png)
909+
* More content for this entry. And a screenshot:<br/><img src={useBaseUrl('img/apm/span-hover-view.png')} alt="Span hover" style={{border: '1px solid gray'}} width="400" />
910910

911911
</TabItem>
912912
</Tabs>
@@ -1271,10 +1271,6 @@ In the UI, avoid periods for single sentences on their own. Whenever there are t
12711271
12721272
Our release notes (also known as changelog) are posted to the both the docs site and corresponding RSS feed. Check out the categories [here](/docs/release-notes). Keep your them concise and add links to documentation. If there are updated UI elements, add an image or gif.
12731273
1274-
### Text only
1275-
1276-
To add a text-only release note:
1277-
12781274
1. In the appropriate blog folder ([blog-collector](https://github.com/SumoLogic/sumologic-documentation/tree/main/blog-collector), [blog-cse](https://github.com/SumoLogic/sumologic-documentation/tree/main/blog-cse), [blog-csoar](https://github.com/SumoLogic/sumologic-documentation/tree/main/blog-csoar), [blog-developer](https://github.com/SumoLogic/sumologic-documentation/tree/main/blog-developer), [blog-service](https://github.com/SumoLogic/sumologic-documentation/tree/main/blog-service)), add a new file that follows the format of the other posts in that folder. For example, for blog-service release notes, the format is `YYYY-MM-DD-<product/feature>`. For Cloud SIEM and SOAR, the format is `YYYY-MM-DD-application-update` or `YYYY-MM-DD-content-update`.<br/><img src={useBaseUrl('img/contributing/release-notes-dropdown-menu.png')} alt="Release notes menu" style={{border: '1px solid gray'}} width="200"/>
12791275
1. Add the following frontmatter, swapping out these example values with your own. Because there's no `image`, we'll use the Sumo Logic logo in its place.
12801276
```markdown
@@ -1294,29 +1290,10 @@ To add a text-only release note:
12941290
* `hide-table-of-contents`. Hide the TOC on the page, keeping the notes clean and wide on the page.
12951291
1. Document the release notes. Add links, bullets, and images as needed.
12961292
1297-
#### Long release notes
1293+
### Long release notes
12981294
12991295
For lengthy release notes, we recommend introducing the notes and adding a truncate line (`<!--truncate-->`), followed by the full set of release notes.
13001296
1301-
### Text and images
1302-
1303-
To add release notes with images:
1304-
1305-
1. In the blog folder, create a new folder with the following name format: `YYYY-MM-DD-product`.
1306-
1. In the new folder, create a markdown file named `index.md`.
1307-
1. Add your release notes with frontmatter:
1308-
```markdown
1309-
---
1310-
title: New XYZ Feature
1311-
hide_table_of_contents: true
1312-
keywords:
1313-
- alerts
1314-
image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082
1315-
---
1316-
```
1317-
1. Save the image to this folder and add them to the markdown file: `![alt text](image-name.png)`.
1318-
1319-
13201297
## Reusing content
13211298
13221299
For repeatable content - an identical section that appears in one or more docs - you can save a lot of time by creating one instance of that content in the `/docs/reuse` folder and then importing that snippet to other docs.
@@ -1386,7 +1363,7 @@ Tables use plain markdown with one header, default left-aligned columns, and mul
13861363
| Started At | 07/27/2020 09:01:04.533 | When the trace started. |
13871364
| Duration | 12.582 ms | The amount of time the trace spans. |
13881365
| Number of spans | 35 | A trace consists of spans. This number tells you how many spans are in the trace. |
1389-
| Duration Breakdown | ![breakdown](/img/apm/traces/breakdown.png) | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.<br/>Hover over to view a percentage breakdown of how long each span covers in the trace.<br/>![span hover](/img/apm/traces/span-hover-view.png) |
1366+
| Duration Breakdown | <img src={useBaseUrl('img/apm/traces/breakdown.png')} alt="Breakdown" style={{border: '1px solid gray'}} width="200" /> | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.<br/>Hover over to view a percentage breakdown of how long each span covers in the trace.<br/><img src={useBaseUrl('img/apm/span-hover-view.png')} alt="Span hover" style={{border: '1px solid gray'}} width="300" /> |
13901367
| Number of errors | 0 | The number of errors in the trace. |
13911368
| Status | 200 | The HTTP status code of the trace. |
13921369
```
@@ -1421,7 +1398,7 @@ Markdown | Less | Pretty
14211398
| Started At | 07/27/2020 09:01:04.533 | When the trace started. |
14221399
| Duration | 12.582 ms | The amount of time the trace spans. |
14231400
| Number of spans | 35 | A trace consists of spans. This number tells you how many spans are in the trace. |
1424-
| Duration Breakdown | ![breakdown](/img/apm/traces/breakdown.png) | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.<br/>Hover over to view a percentage breakdown of how long each span covers in the trace.<br/>![span hover](/img/apm/span-hover-view.png) |
1401+
| Duration Breakdown | <img src={useBaseUrl('img/apm/traces/breakdown.png')} alt="Breakdown" style={{border: '1px solid gray'}} width="200" /> | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.<br/>Hover over to view a percentage breakdown of how long each span covers in the trace.<br/><img src={useBaseUrl('img/apm/span-hover-view.png')} alt="Span hover" style={{border: '1px solid gray'}} width="300" /> |
14251402
| Number of errors | 0 | The number of errors in the trace. |
14261403
| Status | 200 | The HTTP status code of the trace. |
14271404

docs/contributing/templates/generic-doc.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ description: Example template for creating a document in the Sumo Logic guides.
99
<meta name="robots" content="noindex" />
1010
</head>
1111

12+
import useBaseUrl from '@docusaurus/useBaseUrl';
13+
1214
<!--Copy this markdown file and replace it with your own documentation. To view the full list of markdown components, see our [Style Guide](/docs/contributing/style-guide).
1315
1416
Replace the title above in the [Frontmatter section](/docs/contributing/style-guide#frontmatter) with yours. This will render as an H1 header. All other header sections should be H2, H3, H4, or H5.-->
@@ -20,7 +22,7 @@ To add an image, save the .png file with a simple name to the `/static/img` fold
2022
2123
Example:
2224
23-
![Sumo Logic logo](/img/reuse/sumo-square.png)
25+
<img src={useBaseUrl('img/reuse/sumo-square.png')} alt="Sumo Logic logo" style={{border: '1px solid gray'}} width="50" />
2426
-->
2527

2628
### Instructions
@@ -31,7 +33,7 @@ Always use `1.` to start your instructions. You do not need to actually number t
3133
1. Click **Collections**, then **Sources** tab.
3234
1. Next step, just write it out.
3335
* Bullet list just tab and use `*` or `1.`.
34-
* Next bullet.<br/>![Sumo Logic logo](/img/reuse/sumo-square.png)
36+
* Next bullet.<br/><img src={useBaseUrl('img/reuse/sumo-square.png')} alt="Sumo Logic logo" style={{border: '1px solid gray'}} width="50" />
3537
1. The numbers continue with content indented above!
3638
3739
Here is an example table:

0 commit comments

Comments
 (0)