update readme according to ndc connector template #102
Conversation
This file contains hidden or 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
daniel-chambers
approved these changes
Sep 12, 2024
…-to-ndc-connector-template
codedmart
approved these changes
Sep 12, 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.
This is a rewrite of the readme according to the template from https://github.com/hasura/ndc-connector-template. The content that was previously in the readme has mostly been moved to docs/development.md, docs/building.md, and docs/docker-images.md. I also moved content that was in DEVELOPING.md into docs/developing.md.
I removed some docs pages from the template. I filed a ticket to follow up on these: https://linear.app/hasura/issue/NDC-442/add-more-mongodb-connector-docs-pages
I also expanded the documentation.
docs/limitations.md only has a couple of items. This should be expanded as we remember the things we've been meaning to put in such a document.
At least some of this content should be on the docs website. I'm going to be moving information there, and updating both sets of documentation on an ongoing basis.