github.com/eliastor/durgaform@v0.0.0-20220816172711-d0ab2d17673e/docs/README.md (about)

     1  # Durgaform Core Codebase Documentation
     2  
     3  This directory contains some documentation about the Durgaform Core codebase,
     4  aimed at readers who are interested in making code contributions.
     5  
     6  If you're looking for information on _using_ Durgaform, please instead refer
     7  to [the main Durgaform CLI documentation](https://www.durgaform.io/docs/cli/index.html).
     8  
     9  ## Durgaform Core Architecture Documents
    10  
    11  * [Durgaform Core Architecture Summary](./architecture.md): an overview of the
    12    main components of Durgaform Core and how they interact. This is the best
    13    starting point if you are diving in to this codebase for the first time.
    14  
    15  * [Resource Instance Change Lifecycle](./resource-instance-change-lifecycle.md):
    16    a description of the steps in validating, planning, and applying a change
    17    to a resource instance, from the perspective of the provider plugin RPC
    18    operations. This may be useful for understanding the various expectations
    19    Durgaform enforces about provider behavior, either if you intend to make
    20    changes to those behaviors or if you are implementing a new Durgaform plugin
    21    SDK and so wish to conform to them.
    22  
    23    (If you are planning to write a new provider using the _official_ SDK then
    24    please refer to [the Extend documentation](https://www.durgaform.io/docs/extend/index.html)
    25    instead; it presents similar information from the perspective of the SDK
    26    API, rather than the plugin wire protocol.)
    27  
    28  * [Plugin Protocol](./plugin-protocol/): gRPC/protobuf definitions for the
    29    plugin wire protocol and information about its versioning strategy.
    30  
    31    This documentation is for SDK developers, and is not necessary reading for
    32    those implementing a provider using the official SDK.
    33  
    34  * [How Durgaform Uses Unicode](./unicode.md): an overview of the various
    35    features of Durgaform that rely on Unicode and how to change those features
    36    to adopt new versions of Unicode.
    37  
    38  ## Contribution Guides
    39  
    40  * [Maintainer Etiquette](./maintainer-etiquette.md): guidelines and expectations
    41    for those who serve as Pull Request reviewers, issue triagers, etc.