Skip to content

Conversation

@jaugust4
Copy link

Added documentation requested in issue #152

Ready to Review and Edit

Creating Index.yaml-Explanation.md
Copy link
Member

@seanlip seanlip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants