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.

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

Add additional line breaks before sigils #10

Merged
merged 2 commits into from
Jul 16, 2024
Merged

Add additional line breaks before sigils #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fdc96f
Add additional line breaks before sigils
alexhung Jul 16, 2024
5d0399c
Update CHANGELOG
alexhung Jul 16, 2024
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 1.0.1 (July 16, 2024). Tested on Artifactory 7.84.17 with Terraform 1.9.2 and OpenTofu 1.7.3

IMPROVEMENTS:

* resource/missioncontrol_access_federation_mesh, resource/missioncontrol_access_federation_star, resource/missioncontrol_jpd: Fix documentation formatting. PR: [#10](https://github.com/jfrog/terraform-provider-mission-control/pull/10)

## 1.0.0 (July 16, 2024). Tested on Artifactory 7.84.17 with Terraform 1.9.2 and OpenTofu 1.7.3

FEATURES:
Expand Down
2 changes: 2 additions & 0 deletions docs/resources/access_federation_mesh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ description: |-
# missioncontrol_access_federation_mesh (Resource)

Provides a [JFrog Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation) resource to setup Mesh Topology.

~>The source and targets must have been configured properly for [Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation).

~>**Deletion** is currently not supported via REST API. This must be done using JFrog UI.

## Example Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/resources/access_federation_star.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ description: |-
# missioncontrol_access_federation_star (Resource)

Provides a [JFrog Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation) resource to setup Star Topology.

~>The source and targets must have been configured properly for [Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation).

~>**Deletion** is currently not supported via REST API. This must be done using JFrog UI.

## Example Usage
Expand Down
3 changes: 2 additions & 1 deletion docs/resources/jpd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ description: |-
# missioncontrol_jpd (Resource)

Provides a [JFrog Platform Deployment](https://jfrog.com/help/r/jfrog-platform-administration-documentation/manage-platform-deployments) resource to manage JPD.

~>Supported on the Self-Hosted platform, with an Enterprise X or Enterprise+ license.


Expand All @@ -21,7 +22,7 @@ Provides a [JFrog Platform Deployment](https://jfrog.com/help/r/jfrog-platform-a

- `location` (Attributes) The geographical location of the Platform Deployment to be displayed on a global Platform Deployment view (see [below for nested schema](#nestedatt--location))
- `name` (String) A unique logical name for this Platform Deployment
- `url` (String) The Platform deployment URL: http://<hostname>:<port>/; for example: http://myplatformserver:8082/. Note: For legacy instances, version 6.x and lower, the URL should contain the instance root context: http://<hostname>:<port>/<context>/; for example http://myv6server:8081/artifactory/. URL must ends with trailing slash.
- `url` (String) The Platform deployment URL: `http://<hostname>:<port>/`; for example: `http://myplatformserver:8082/`. Note: For legacy instances, version 6.x and lower, the URL should contain the instance root context: `http://<hostname>:<port>/<context>/`; for example `http://myv6server:8081/artifactory/`. URL must ends with trailing slash.

### Optional

Expand Down
4 changes: 2 additions & 2 deletions pkg/missioncontrol/resource_access_federation_mesh.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ func (r *accessFederationMeshResource) Schema(ctx context.Context, req resource.
Description: "Entity types to sync. Allow values: `USERS`, `GROUPS`, `PERMISSIONS`, `TOKENS`",
},
},
MarkdownDescription: "Provides a [JFrog Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation) resource to setup Mesh Topology.\n" +
"~>The source and targets must have been configured properly for [Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation).\n" +
MarkdownDescription: "Provides a [JFrog Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation) resource to setup Mesh Topology.\n\n" +
"~>The source and targets must have been configured properly for [Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation).\n\n" +
"~>**Deletion** is currently not supported via REST API. This must be done using JFrog UI.",
}
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/missioncontrol/resource_access_federation_star.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ func (r *accessFederationStarResource) Schema(ctx context.Context, req resource.
Description: "Target JPD",
},
},
MarkdownDescription: "Provides a [JFrog Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation) resource to setup Star Topology.\n" +
"~>The source and targets must have been configured properly for [Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation).\n" +
MarkdownDescription: "Provides a [JFrog Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation) resource to setup Star Topology.\n\n" +
"~>The source and targets must have been configured properly for [Access Federation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-federation).\n\n" +
"~>**Deletion** is currently not supported via REST API. This must be done using JFrog UI.",
}
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/missioncontrol/resource_jpd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func (r *jpdResource) Schema(ctx context.Context, req resource.SchemaRequest, re
validator_string.IsURLHttpOrHttps(),
stringvalidator.RegexMatches(regexp.MustCompile(`^.+/$`), "must end in '/'"),
},
Description: "The Platform deployment URL: http://<hostname>:<port>/; for example: http://myplatformserver:8082/. Note: For legacy instances, version 6.x and lower, the URL should contain the instance root context: http://<hostname>:<port>/<context>/; for example http://myv6server:8081/artifactory/. URL must ends with trailing slash.",
Description: "The Platform deployment URL: `http://<hostname>:<port>/`; for example: `http://myplatformserver:8082/`. Note: For legacy instances, version 6.x and lower, the URL should contain the instance root context: `http://<hostname>:<port>/<context>/`; for example `http://myv6server:8081/artifactory/`. URL must ends with trailing slash.",
},
"token": schema.StringAttribute{
Optional: true,
Expand Down Expand Up @@ -187,7 +187,7 @@ func (r *jpdResource) Schema(ctx context.Context, req resource.SchemaRequest, re
Computed: true,
},
},
MarkdownDescription: "Provides a [JFrog Platform Deployment](https://jfrog.com/help/r/jfrog-platform-administration-documentation/manage-platform-deployments) resource to manage JPD.\n~>Supported on the Self-Hosted platform, with an Enterprise X or Enterprise+ license.",
MarkdownDescription: "Provides a [JFrog Platform Deployment](https://jfrog.com/help/r/jfrog-platform-administration-documentation/manage-platform-deployments) resource to manage JPD.\n\n~>Supported on the Self-Hosted platform, with an Enterprise X or Enterprise+ license.",
}
}

Expand Down
Loading