Add wiki documentation about index.yaml#316
Open
jaugust4 wants to merge 2 commits intooppia:developfrom
Open
Conversation
Creating Index.yaml-Explanation.md
Documentation Update
seanlip
requested changes
Apr 24, 2024
Member
seanlip
left a comment
There was a problem hiding this comment.
Hi @jaugust4, thanks for your PR. I think the thrust of this page is a bit off. index.yaml is already set up and exists for this project, so all the stuff about "how to set up index.yaml from scratch" is irrelevant.
I think this page should explain:
- what index.yaml is and what it's used for
- what sorts of datastore queries will require updates to index.yaml, and which don't
- what developers should do in index.yaml when adding a new multi-field datastore query
Could you please update the page to match the above, and also ensure that you test the flows locally by trying out appropriate changes on the oppia/oppia repo? Please also explain, in your response to this review, how you verified the instructions.
Thanks!
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
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.
Added documentation requested in issue #152
Ready to Review and Edit