Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a wiki page explaining things to consider when making storage model changes. #122

Open
seanlip opened this issue Feb 25, 2023 · 9 comments

Comments

@seanlip
Copy link
Member

seanlip commented Feb 25, 2023

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).

@seanlip
Copy link
Member Author

seanlip commented Feb 25, 2023

@vojtechjelinek @lkbhitesh07 Is there anything you would want to add to such a page re e.g. validation? E.g. deleting models safely, deleting fields safely, etc. -- this page seems like it would be a good place for such topics.

@vojtechjelinek
Copy link
Contributor

I think that after we verify that @lkbhitesh07 approach for the deletion of model filed works we can put it there. Ditto with deleting models.

@U8NWXD
Copy link
Member

U8NWXD commented Mar 28, 2023

@lkbhitesh07 have you confirmed that your approach for deleting a model works?

@lkbhitesh07
Copy link
Member

lkbhitesh07 commented Mar 29, 2023

@lkbhitesh07 have you confirmed that your approach for deleting a model works?

Hey @U8NWXD I have submitted the testing request for the same. I think @kevintab95 will be taking up the testing as @DubeySandeep is busy for the next 3 days. I'm currently in conversation with them via mail.
Thanks

EDIT - Just received the response from @kevintab95 and he will be running the job by Friday.
Thanks

@Shivkant-Chauhan Shivkant-Chauhan moved this from Todo to In Progress in Developer Workflow Team Apr 3, 2023
@Shivkant-Chauhan
Copy link
Contributor

Hi @lkbhitesh07 can you please update the project board with the expected merge date.. thanks!

@lkbhitesh07
Copy link
Member

The job still needs to be tested so I would say that my PR would be merged by 6 April.
Thanks.

@lkbhitesh07
Copy link
Member

Hey guys, just wanted to update the discussion that my PR has been tested successfully on the backup server. I can provide assistance to the wiki page where we are talking about deleting a field from the model.
Thanks

@U8NWXD
Copy link
Member

U8NWXD commented Apr 25, 2023

That's great news @lkbhitesh07! When do you expect to update the wiki page (assuming you are okay with taking up this issue)?

@lkbhitesh07
Copy link
Member

I think I will not be able to carve this wiki page due to a few other commitments I have. I will be providing my assistance in updating the part where we talk about removing some fields from the model because I have worked on that part.

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

No branches or pull requests

6 participants