Skip to content

[docs] Escape left angle bracket (<) #4369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
colleenmcginnis merged 3 commits into from
Oct 3, 2022
Merged

[docs] Escape left angle bracket (<) #4369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13a6f1d
escape left angle bracket
Oct 3, 2022
1ee7b63
add pr link
colleenmcginnis Oct 3, 2022
9b24594
label as bugfix
colleenmcginnis Oct 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions packages/infoblox_bloxone_ddi/_dev/build/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Infoblox BloxOne DDI

## Overview

The [Infoblox BloxOne DDI](https://www.infoblox.com/products/bloxone-ddi/) integration allows you to monitor DNS, DHCP and IP address management activity. DDI is the foundation of core network services that enables all communications over an IP-based network.

Use the Infoblox BloxOne DDI integration to collects and parses data from the REST APIs and then visualize that data in Kibana.
Expand All @@ -27,7 +25,7 @@ This module has been tested against `Infoblox BloxOne DDI API (v1)`.
### To collect data from Infoblox BloxOne DDI APIs, the user must have API Key. To create an API key follow the below steps:

1. Log on to the Cloud Services Portal.
2. Go to **<User_Name> -> User Profile**.
2. Go to **\<User_Name> -> User Profile**.
Copy link
Member

@bmorelli25 bmorelli25 Oct 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@colleenmcginnis FYI we need to be careful with arrows. This one is fine, but if it had two dashes (-->) it would be considered an HTML comment and replaced.

https://github.com/elastic/wordlake/blob/main/utils/integrations-exporter/content/content.go#L38

3. Go to **User API Keys** page.
4. Click **Create** to create a new API key. Specify the following:
- **Name**: Specify the name of the key.
Expand Down
5 changes: 5 additions & 0 deletions packages/infoblox_bloxone_ddi/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: '0.1.1'
changes:
- description: Fix documentation build error.
type: bugfix
link: https://github.com/elastic/integrations/pull/4369
- version: '0.1.0'
changes:
- description: Initial Release.
Expand Down
4 changes: 1 addition & 3 deletions packages/infoblox_bloxone_ddi/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Infoblox BloxOne DDI

## Overview

The [Infoblox BloxOne DDI](https://www.infoblox.com/products/bloxone-ddi/) integration allows you to monitor DNS, DHCP and IP address management activity. DDI is the foundation of core network services that enables all communications over an IP-based network.

Use the Infoblox BloxOne DDI integration to collects and parses data from the REST APIs and then visualize that data in Kibana.
Expand All @@ -27,7 +25,7 @@ This module has been tested against `Infoblox BloxOne DDI API (v1)`.
### To collect data from Infoblox BloxOne DDI APIs, the user must have API Key. To create an API key follow the below steps:

1. Log on to the Cloud Services Portal.
2. Go to **<User_Name> -> User Profile**.
2. Go to **\<User_Name> -> User Profile**.
3. Go to **User API Keys** page.
4. Click **Create** to create a new API key. Specify the following:
- **Name**: Specify the name of the key.
Expand Down
2 changes: 1 addition & 1 deletion packages/infoblox_bloxone_ddi/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: 1.0.0
name: infoblox_bloxone_ddi
title: Infoblox BloxOne DDI
version: '0.1.0'
version: '0.1.1'
license: basic
description: Collect logs from Infoblox BloxOne DDI with Elastic Agent.
type: integration
Expand Down