Skip to content

Commit

Permalink
docs(contrib-dev): fix path to services (#4)
Browse files Browse the repository at this point in the history
This pull request includes updates to the documentation to reflect
changes in the directory structure for the implementation and schema
descriptions of resources and data sources.

Documentation updates:

*
[`CONTRIBUTING.md`](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L41-R45):
Updated the path for the implementation and schema descriptions of
resources and data sources to `./internal/services` instead of
`./internal/provider/services`.
*
[`DEVELOPER.md`](diffhunk://#diff-35ea617bfbf0780bfbc554348314c5b11ba478a4d98fd92d33d45cdd54bf326aL355-R355):
Updated the path for the schema information in the provider, resource,
and data-source Go files to `./internal/services` instead of
`./internal/provider/services`.
  • Loading branch information
DariuszPorowski authored Sep 20, 2024
1 parent 56c8c1c commit aefa6e8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ Examples of real-world use cases are encouraged. Please contribute those types o

PRs for new resources or data sources are expected to meeting the following criteria:

- Add a production quality implementation of the resource or data-source in [./internal/provider/services](./internal/provider/services)
- Add a production quality implementation of the resource or data-source in [./internal/services](./internal/services)
- Add unit tests and acceptance tests for your contribution in [./internal/provider](./internal/provider)
- Tests should pass and provide >90% coverage of your contribution
- Add examples for your contribution in [./examples](./examples) (see [Terraform Documentation on examples](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-documentation-generation#add-configuration-examples))
- Add [schema descriptions](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-documentation-generation#add-schema-descriptions) for your resource or data-source in [./internal/provider/services](./internal/provider/services)
- Add [schema descriptions](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-documentation-generation#add-schema-descriptions) for your resource or data-source in [./internal/services](./internal/services)
- and/or [./templates](./templates)
- Update auto-generated documentation in [./docs](./docs). (DO NOT manually edit [./docs](./docs) or your updates will be overwritten)
- Ensure the PR description clearly describes the feature you're adding and any known limitations
Expand Down
2 changes: 1 addition & 1 deletion DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ User documentation markdown files in [./docs](./docs/) are auto-generated by the

**DO NOT** manually edit the markdown files in [./docs](./docs/). If you need to edit documentation edit the following sources:

- schema information in the provider, resource, and data-source golang files that are in [./internal/provider/services](./internal/provider/services)
- schema information in the provider, resource, and data-source golang files that are in [./internal/services](./internal/services)
- [template files](./templates/)

```sh
Expand Down

0 comments on commit aefa6e8

Please sign in to comment.