oppia / oppia/oppia-web-developer-docs
Provide a wiki page explaining things to consider when making storage model changes.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
Currently, most contributors (probably) don't know how to update the index.yaml file when making changes to the datastore that involve querying on 2 or more fields. This can lead to errors when the PR is subsequently deployed to production.
We should have a wiki page that explains things to be aware of when making storage model changes, and that details how to make them safely. This page should detail common operations like updating the index.yaml file (see discussion at https://github.com/oppia/oppia/pull/17259/files#r1098564239).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing wiki contribution guidance and the linked discussion in PR #17259, especially the changes involving index.yaml. Document the storage-model considerations and safe index.yaml update workflow, including common operations; the page is done when contributors can use it to avoid deployment errors when querying on multiple fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100