Skip to content

Commit

Permalink
Merge pull request #114 from smutel/ImproveDocs
Browse files Browse the repository at this point in the history
docs: Update docs
  • Loading branch information
smutel authored May 19, 2022
2 parents 5976f5a + e82050b commit 689cd6f
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: "[Main title for your issue here]"
labels: bug
assignees: smutel
---
<!--- BEFORE CREATING A NEW ISSUE, ENSURE THAT THE PROVIDER VERSION THAT YOUR ARE USING IS -->
<!--- COMPATIBLE WITH YOUR VERSION OF NETBOX. PLEASE CHECK THE COMPATIBILITY MATRIX HERE -->
<!--- https://github.com/smutel/terraform-provider-netbox#compatibility-with-netbox -->

<!--- Verify first that your issue is not already reported on GitHub -->
<!--- Ensure that the latest release is affected by this bug -->
<!--- Complete most of sections below as described -->
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ Terraform provider for [Netbox.](https://netbox.readthedocs.io/en/stable/)
| 2.9 | 1.x.y |
| 2.11 | 2.x.y |
| 3.0 | 3.x.y |
| 3.1 | 4.x.y |

## go-netbox

This project does not use [netbox-community/go-netbox](https://github.com/netbox-community/go-netbox) but the same library generated by myself located here [smutel/go-netbox](https://github.com/smutel/go-netbox) for three reasons:
* By the past this project was not maintained anymore so I decided to create my own project
* I am using a [patch strategy](https://github.com/smutel/go-netbox/tree/main/patchs) and generation of the library [by the CI](https://github.com/smutel/go-netbox/blob/main/utils/netbox_generate_client)
* I does not need to wait if I need a patch quickly

## Building the provider

Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Terraform provider for [Netbox.](https://netbox.readthedocs.io/en/stable/)
| 2.9 | 1.x.y |
| 2.11 | 2.x.y |
| 3.0 | 3.x.y |
| 3.1 | 4.x.y |

## Example Usage

Expand All @@ -19,7 +20,7 @@ terraform {
required_providers {
netbox = {
source = "smutel/netbox"
version = "~> 3.1.0"
version = "~> 4.0.0"
}
}
}
Expand Down

0 comments on commit 689cd6f

Please sign in to comment.