Skip to content
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.

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

docs: Adding Network Resource and data source examples to the doc #580

Merged
merged 5 commits into from
Feb 22, 2024

Conversation

srushti-patl
Copy link
Contributor

@srushti-patl srushti-patl commented Feb 21, 2024

Added Fabric Network Resource and Data Source examples to the docs

@srushti-patl srushti-patl requested a review from a team as a code owner February 21, 2024 06:40
@srushti-patl srushti-patl changed the title doc: Adding Network Resource and data source examples to the doc docs: Adding Network Resource and data source examples to the doc Feb 21, 2024
Copy link
Contributor

@thogarty thogarty left a comment

Choose a reason for hiding this comment

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

@srushti-patl Approved, but please update the indentation on the project_id before merging.

emails = ["example@equinix.com","test1@equinix.com"]
}
project {
project_id = "776847000642406"
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: indentation is different for notifications and for project. Terraform fmt resolves to 2 spaces per tab. Our examples should follow the same format.

You can modify your editor settings to have it default to that for future things.

Copy link
Contributor

Choose a reason for hiding this comment

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

Indentation is still off.

## Example Usage

```hcl
data "equinix_fabric_network" "network_data_name" {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is perfect for how the data source is used.

Though something we're working towards is having the data source examples include outputs that provide the attribute mappings (data selections like how we do with connections getting the redundancy group) so the customers are educated on how to retrieve the different elements from the data source.

If you find it to be quick then include. If not just let me know in a comment and we'll setup a task to pickup in Jira for getting the data source docs updated all at once.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could we follow up on this task later? I will create a JIRA task for updating all the data sources

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good!

@thogarty thogarty added the area/resources/fabric Issues related to Fabric and ECX APIs label Feb 21, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.46%. Comparing base (93c3834) to head (64ea46b).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #580   +/-   ##
=======================================
  Coverage   44.46%   44.46%           
=======================================
  Files          93       93           
  Lines       18164    18164           
=======================================
  Hits         8077     8077           
  Misses       9883     9883           
  Partials      204      204           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@thogarty thogarty left a comment

Choose a reason for hiding this comment

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

Approving; you should be able to fix indentation and merge after.

## Example Usage

```hcl
data "equinix_fabric_network" "network_data_name" {
Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good!

emails = ["example@equinix.com","test1@equinix.com"]
}
project {
project_id = "776847000642406"
Copy link
Contributor

Choose a reason for hiding this comment

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

Indentation is still off.

@srushti-patl srushti-patl merged commit 837e2c7 into main Feb 22, 2024
2 checks passed
@srushti-patl srushti-patl deleted the CXF-76681-Fabric-Network-Resource-Doc-Update branch February 22, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/resources/fabric Issues related to Fabric and ECX APIs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants