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

update doc files for Projects #4681

Merged
merged 67 commits into from
Jul 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
b106d00
fix: generate project code
dvesperini Apr 6, 2023
a1229cd
fix: fix build
dvesperini Apr 6, 2023
ff4c819
fix: add examples and markdown files
dvesperini Apr 6, 2023
5ef6411
fix: mark new false positive secrets
dvesperini Apr 6, 2023
6729e08
fix: fix review
dvesperini Apr 12, 2023
bc99b6c
fix: fix links
dvesperini Apr 13, 2023
7d86c6d
fix: fix test
dvesperini Apr 13, 2023
8fa9ab8
fix: remove regex check
dvesperini Apr 14, 2023
a27a0f9
fix: fix id to project_id
dvesperini Apr 14, 2023
b4e022e
fix: fix integration test project
dvesperini Apr 14, 2023
22463b8
fix: fix resource_group values
dvesperini Apr 14, 2023
fcd552e
fix: last changes
dvesperini Apr 15, 2023
864628d
Merge branch 'master' into test
riccardo-angelilli Apr 21, 2023
1eff6ad
Merge branch 'IBM-Cloud:master' into test
riccardo-angelilli Apr 21, 2023
34fbcfc
fix integration test
riccardo-angelilli Apr 21, 2023
8c1b010
fix integration test
riccardo-angelilli Apr 21, 2023
d121deb
Merge branch 'IBM-Cloud:master' into test
riccardo-angelilli Apr 26, 2023
774aafa
fix integration test
riccardo-angelilli Apr 26, 2023
ddfb9bc
fix integration test
riccardo-angelilli Apr 27, 2023
232c276
fix integration test
riccardo-angelilli Apr 27, 2023
da5fb09
Merge branch 'IBM-Cloud:master' into test
riccardo-angelilli Apr 27, 2023
d4d39f2
fix integration test
riccardo-angelilli Apr 27, 2023
4b6e36f
fix name
riccardo-angelilli May 2, 2023
c4f1a14
pr comments
riccardo-angelilli May 3, 2023
40ef829
pr comments
riccardo-angelilli May 3, 2023
33260af
fix doc
riccardo-angelilli May 4, 2023
d20d0b5
Merge branch 'IBM-Cloud:master' into test
riccardo-angelilli May 4, 2023
2dbbd8f
fix doc
riccardo-angelilli May 4, 2023
6c1c1f5
Merge branch 'IBM-Cloud:master' into test
riccardo-angelilli May 4, 2023
b484085
Merge pull request #1 from dvesperini/test
riccardo-angelilli May 5, 2023
97abc9e
new version
dvesperini May 7, 2023
73b7814
new version
dvesperini May 7, 2023
c0469bd
new version
dvesperini May 8, 2023
075da8d
new version
dvesperini May 8, 2023
edc3c18
update code to the latest SDK level
riccardo-angelilli May 8, 2023
66eab89
fix integration tests
riccardo-angelilli May 8, 2023
074cc3e
fix integration tests
riccardo-angelilli May 8, 2023
1f153d4
fix integration tests
riccardo-angelilli May 9, 2023
a81ee33
fix integration tests
riccardo-angelilli May 9, 2023
3565575
Merge pull request #3 from dvesperini/new_version_correct
riccardo-angelilli May 9, 2023
67cd100
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 10, 2023
e5b7d87
address PR comment
riccardo-angelilli May 10, 2023
1a956bd
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 10, 2023
22280ed
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 11, 2023
b6b0339
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 12, 2023
544fae8
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 14, 2023
974d5a5
typo
riccardo-angelilli May 15, 2023
0581a06
typo
riccardo-angelilli May 15, 2023
b7d42ef
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 19, 2023
7016d8d
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 23, 2023
c335f96
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli May 24, 2023
10ee8c6
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jun 1, 2023
21813fb
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jun 6, 2023
daf5f9b
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jun 12, 2023
e55dfd1
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jun 15, 2023
9f33afd
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jun 20, 2023
4c4e16f
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jun 23, 2023
d8fad2b
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jul 6, 2023
75160a3
Merge branch 'IBM-Cloud:master' into master
riccardo-angelilli Jul 11, 2023
e5fb114
Update project_instance.html.markdown
knee-na Jul 11, 2023
0a855f6
Update project_event_notification.html.markdown
knee-na Jul 11, 2023
5360eae
Merge pull request #4 from knee-na/patch-2
riccardo-angelilli Jul 12, 2023
b440ddd
Merge pull request #5 from knee-na/patch-3
riccardo-angelilli Jul 12, 2023
396e3cd
Merge pull request #6 from dvesperini/doc_updates
riccardo-angelilli Jul 12, 2023
4a79f6a
Update README.md
riccardo-angelilli Jul 12, 2023
bd549b1
Update variables.tf
riccardo-angelilli Jul 12, 2023
bea919d
Update project_event_notification.html.markdown
riccardo-angelilli Jul 12, 2023
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
14 changes: 7 additions & 7 deletions website/docs/d/project_event_notification.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Nested scheme for **configs**:

* `metadata` - (List) The metadata of the project.
Nested scheme for **metadata**:
* `created_at` - (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339.
* `created_at` - (String) A date and time value in the format `YYYY-MM-DDTHH:mm:ssZ` or `YYYY-MM-DDTHH:mm:ss.sssZ`, matching the date and time format as specified by RFC 3339.
* `crn` - (String) An IBM Cloud resource name, which uniquely identifies a resource.
* Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`.
* `cumulative_needs_attention_view` - (List) The cumulative list of needs attention items for a project.
Expand All @@ -88,20 +88,20 @@ Nested scheme for **metadata**:
* Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`.
* `config_version` - (Integer) The version number of the configuration.
* `event` - (String) The event name.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `event_id` - (String) The unique ID of a project.
* Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`.
* `cumulative_needs_attention_view_err` - (String) \"True\" indicates that the fetch of the needs attention items failed.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* `cumulative_needs_attention_view_err` - (String) `True` indicates that the fetch of the needs attention items failed.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `event_notifications_crn` - (String) The CRN of the event notifications instance if one is connected to this project.
* Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`.
* `location` - (String) The IBM Cloud location where a resource is deployed.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `resource_group` - (String) The resource group where the project's data and tools are created.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `state` - (String) The project status value.
* Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(CREATING|CREATING_FAILED|UPDATING|UPDATING_FAILED|READY)$/`.

* `name` - (String) The project name.
* Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/`.

16 changes: 8 additions & 8 deletions website/docs/r/project_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ Nested scheme for **configs**:
* `location` - (Required, String) The location where the project's data and tools are created.
* Constraints: The maximum length is `12` characters. The minimum length is `0` characters. The value must match regular expression `/^$|^(us-south|us-east|eu-gb|eu-de)$/`.
* `name` - (Required, String) The project name.
* Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]+$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/`.
* `resource_group` - (Required, String) The resource group where the project's data and tools are created.
* Constraints: The maximum length is `40` characters. The minimum length is `0` characters. The value must match regular expression `/^$|^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* Constraints: The maximum length is `40` characters. The minimum length is `0` characters. The value must match regular expression `/^$|^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.

## Attribute Reference

Expand All @@ -83,7 +83,7 @@ In addition to all argument references listed, you can access the following attr
* Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`.
* `metadata` - (List) The metadata of the project.
Nested scheme for **metadata**:
* `created_at` - (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date and time format as specified by RFC 3339.
* `created_at` - (String) A date and time value in the format `YYYY-MM-DDTHH:mm:ssZ` or `YYYY-MM-DDTHH:mm:ss.sssZ`, matching the date and time format as specified by RFC 3339.
* `crn` - (String) An IBM Cloud resource name, which uniquely identifies a resource.
* Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`.
* `cumulative_needs_attention_view` - (List) The cumulative list of needs attention items for a project.
Expand All @@ -93,17 +93,17 @@ Nested scheme for **metadata**:
* Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`.
* `config_version` - (Integer) The version number of the configuration.
* `event` - (String) The event name.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `event_id` - (String) The unique ID of a project.
* Constraints: The maximum length is `128` characters. The value must match regular expression `/^[\\.\\-0-9a-zA-Z]+$/`.
* `cumulative_needs_attention_view_err` - (String) \"True\" indicates that the fetch of the needs attention items failed.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* `cumulative_needs_attention_view_err` - (String) `True` indicates that the fetch of the needs attention items failed.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `event_notifications_crn` - (String) The CRN of the event notifications instance if one is connected to this project.
* Constraints: The maximum length is `512` characters. The minimum length is `9` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9\\-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/`.
* `location` - (String) The IBM Cloud location where a resource is deployed.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `resource_group` - (String) The resource group where the project's data and tools are created.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"`<>{}\\x00-\\x1F]*$/`.
* Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/`.
* `state` - (String) The project status value.
* Constraints: The maximum length is `64` characters. The minimum length is `1` character. The value must match regular expression `/^(CREATING|CREATING_FAILED|UPDATING|UPDATING_FAILED|READY)$/`.

Expand Down