Skip to content

Commit

Permalink
docs: Fabric docs consistency (#681)
Browse files Browse the repository at this point in the history
* Add getting started and API links to each data source and resource in
Fabric
  • Loading branch information
thogarty authored May 22, 2024
1 parent 1ef2417 commit c9054be
Show file tree
Hide file tree
Showing 13 changed files with 47 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/data-sources/equinix_fabric_cloud_router.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ description: |-

Fabric V4 API compatible data resource that allow user to fetch Fabric Cloud Router for a given UUID

API documentation can be found here - https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-cloud-routers
Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/FCR/FCR-intro.htm#HowItWorks>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-cloud-routers>

## Example Usage

Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/equinix_fabric_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible data resource that allow user to fetch connection for a given UUID

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-connections-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#connections>

## Example Usage

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/equinix_fabric_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible data resource that allow user to fetch Fabric Network for a given UUID

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-networks-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-networks>

## Example Usage

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/equinix_fabric_port.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible data resource that allow user to fetch port by uuid

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-ports-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#ports>

## Example Usage

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/equinix_fabric_ports.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible data resource that allow user to fetch port by name

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-ports-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#ports>

## Example Usage

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/equinix_fabric_routing_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Fabric V4 API compatible data resource that allow user to fetch routing protocol

API documentation can be found here - https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#routing-protocols

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/FCR/connections/FCR-connect-azureQC.htm#ConfigureRoutingDetailsintheFabricPortal>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#routing-protocols>

## Example Usage

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/equinix_fabric_service_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible data resource that allow user to fetch Service Profile by UUID filter criteria

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-Sprofiles-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#service-profiles>

## Example Usage

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/equinix_fabric_service_profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible data resource that allow user to fetch Service Profile by name filter criteria

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-Sprofiles-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#service-profiles>

## Example Usage

```hcl
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/equinix_fabric_cloud_router.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

Fabric V4 API compatible resource allows creation and management of [Equinix Fabric Cloud Router](https://docs.equinix.com/en-us/Content/Interconnection/FCR/FCR-intro.htm#HowItWorks).

Additional Fabric Cloud Router documentation:
Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/FCR/FCR-intro.htm#HowItWorks>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-cloud-routers>

Expand Down
4 changes: 4 additions & 0 deletions docs/resources/equinix_fabric_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible resource allows creation and management of Equinix Fabric connection

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-connections-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#connections>

## Supporting Modules

The direct usage of the resources is given in the next section "Example Usage". We also have supporting
Expand Down
4 changes: 4 additions & 0 deletions docs/resources/equinix_fabric_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible resource allows creation and management of Equinix Fabric Network

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-networks-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-networks>

## Example Usage

```hcl
Expand Down
4 changes: 3 additions & 1 deletion docs/resources/equinix_fabric_routing_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ description: |-

Fabric V4 API compatible resource allows creation and management of Equinix Fabric connection

API documentation can be found here - https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#routing-protocols
Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/FCR/connections/FCR-connect-azureQC.htm#ConfigureRoutingDetailsintheFabricPortal>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#routing-protocols>

## Example Usage

Expand Down
4 changes: 4 additions & 0 deletions docs/resources/equinix_fabric_service_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ description: |-

Fabric V4 API compatible resource allows creation and management of Equinix Fabric Service Profile

Additional documentation:
* Getting Started: <https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-Sprofiles-implement.htm>
* API: <https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#service-profiles>

## Example Usage

```hcl
Expand Down

0 comments on commit c9054be

Please sign in to comment.