Skip to content

Commit

Permalink
INBOX-2196: create docs for networks datasource
Browse files Browse the repository at this point in the history
  • Loading branch information
James Farrell authored and James Farrell committed Jan 19, 2023
1 parent 1468a1c commit 1935cd9
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ website/node_modules
*.test
*.iml
*.vscode

go.work
go.work.sum
website/vendor

# Test exclusions
Expand Down
40 changes: 40 additions & 0 deletions website/docs/d/networks.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
layout: "ns1"
page_title: "NS1: ns1_networks"
sidebar_current: "docs-ns1-datasource-networks"
description: |-
Provides details about NS1 Networks.
---

# Data Source: ns1_networks

Provides details about NS1 Networks. Use this if you would simply like to read
information from NS1 into your configurations. For read/write operations, you
should use a resource.

## Example Usage

```hcl
# Get details about NS1 Networks.
data "ns1_networks" "example" {
}
```

## Argument Reference

There are no required arguments.

## Attributes Reference

The following are attributes exported:

* `networks` - A set of the available networks. [Networks](#networks) is
documented below.

#### Networks

A network has the following fields:

* `label` - Label associated with the network.
* `name` - Name of the network.
* `network_id` - network ID (`int`). Default is network 0, the primary NS1 Managed DNS Network.
6 changes: 6 additions & 0 deletions website/ns1.erb
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@
<li<%= sidebar_current("docs-ns1-datasource-dnssec") %>>
<a href="/docs/providers/ns1/d/dnssec.html">ns1_dnssec</a>
</li>
<li<%= sidebar_current("docs-ns1-datasource-dnssec") %>>
<a href="/docs/providers/ns1/d/record.html">ns1_dnssec</a>
</li>
<li<%= sidebar_current("docs-ns1-datasource-dnssec") %>>
<a href="/docs/providers/ns1/d/networks.html">ns1_dnssec</a>
</li>
</ul>
</li>

Expand Down

0 comments on commit 1935cd9

Please sign in to comment.