IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2024-12-24 08:00:17 -06:00
Code Issues Packages Projects Releases Wiki Activity
8a1ec44073
opentofu/docs/README.md

41 lines
2.0 KiB
Markdown
Raw Normal View History

Renaming of Terraform to OpenTF
2023-08-22 04:38:28 -05:00
# OpenTF Core Codebase Documentation
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
Renaming of Terraform to OpenTF
2023-08-22 04:38:28 -05:00
This directory contains some documentation about the OpenTF Core codebase,
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
aimed at readers who are interested in making code contributions.
Renaming of Terraform to OpenTF
2023-08-22 04:38:28 -05:00
If you're looking for information on _using_ OpenTF, please instead refer
Change terraform doc website links to be a placeholder for now
2023-08-23 08:56:49 -05:00
to [the main OpenTF CLI documentation](https://www.placeholderplaceholderplaceholder.io/docs/cli/index.html).
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
Renaming of Terraform to OpenTF
2023-08-22 04:38:28 -05:00
## OpenTF Core Architecture Documents
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
Renaming of Terraform to OpenTF
2023-08-22 04:38:28 -05:00
* [OpenTF Core Architecture Summary](./architecture.md): an overview of the
main components of OpenTF Core and how they interact. This is the best
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
starting point if you are diving in to this codebase for the first time.
* [Resource Instance Change Lifecycle](./resource-instance-change-lifecycle.md):
a description of the steps in validating, planning, and applying a change
to a resource instance, from the perspective of the provider plugin RPC
operations. This may be useful for understanding the various expectations
Renaming of Terraform to OpenTF
2023-08-22 04:38:28 -05:00
OpenTF enforces about provider behavior, either if you intend to make
changes to those behaviors or if you are implementing a new OpenTF plugin
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
SDK and so wish to conform to them.
(If you are planning to write a new provider using the _official_ SDK then
Change terraform doc website links to be a placeholder for now
2023-08-23 08:56:49 -05:00
please refer to [the Extend documentation](https://www.placeholderplaceholderplaceholder.io/docs/extend/index.html)
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
instead; it presents similar information from the perspective of the SDK
API, rather than the plugin wire protocol.)
docs: README for the plugin-protocol directory This is an initial partial description of the plugin protocol focused mainly on explaining the purpose of the .proto files. In subsequent updates we will also document the negotiation protocol, etc. For this first pass the goal was just to publish some information that was already available in an internal design document so that it's visible to SDK implementers. It is focused on the .proto versioning strategy because that was the main topic of the internal design documentation this was based on.
2019-06-11 16:27:25 -05:00
* [Plugin Protocol](./plugin-protocol/): gRPC/protobuf definitions for the
plugin wire protocol and information about its versioning strategy.
This documentation is for SDK developers, and is not necessary reading for
those implementing a provider using the official SDK.
Renaming of Terraform to OpenTF
2023-08-22 04:38:28 -05:00
* [How OpenTF Uses Unicode](./unicode.md): an overview of the various
features of OpenTF that rely on Unicode and how to change those features
docs: Some notes on adopting new Unicode versions Previously this is a task that I've just taken on using my own knowledge of how these parts fit together, but that's not at all a sustainable situation, and so here I've just documented the steps I've followed in for previous Unicode version upgrades, and thus which I'd expect to follow for future Unicode version upgrades too. I hope this is also a somewhat-interesting overview of how Terraform makes use of Unicode, even for folks who are just working on the other relevant features of Terraform and not specifically trying to change Terraform's Unicode support. Since I'm the primary maintainer of two of the dependencies involved in this it seems likely that following this process will still involve me in _some_ capacity, but hopefully only necessarily in the form of reviewing PRs and cutting new releases of those libraries.
2021-06-02 19:46:44 -05:00
to adopt new versions of Unicode.
docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.
2019-03-21 19:59:06 -05:00
## Contribution Guides
Fix HTML link in contribution guide (#445)
2023-09-20 03:06:16 -05:00
* [Contributing to OpenTF](../CONTRIBUTING.md): a complete guideline for those who want to contribute to this project.
Reference in New Issue Copy Permalink