Feature/Updating Docs #396
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding docs per the outcome discussed within the issue.
Not requested, but would be nice. Instructions for future contributors to follow when contributing to Tapir.
PacoVK
reviewed
Apr 24, 2024
There was a problem hiding this comment.
@tim-chaffin thanks for your contribution. I really love, you not just improved the docs, but also added Contribution guidelines!
Apart from a very small typo i think this is good to go 🥇
PacoVK
approved these changes
Apr 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request introduces a new document,
docs/CONTRIBUTING, and makes changes to thedocs/configuration.mdfile. The changes aim to provide clearer instructions for future contributors, and introduces more detailed information about the backend and storage configurations of the Tapir project.Contributing Guidelines:
docs/CONTRIBUTING: A new guide on how to contribute to the Tapir project has been added. This guide provides step-by-step instructions on how to fork the repository, create a new branch for changes, commit and push changes, and submit a pull request for review.Configuration Details:
docs/configuration.md: Added a new section detailing the backend configurations supported by Tapir, including Elasticsearch, DynamoDB, and CosmosDB. Also, the description of available storage backends has been updated for better readability.Type of change