gofr icon indicating copy to clipboard operation
gofr copied to clipboard

[DOCS]: Improve clarity and grammar in Migrations documentation

Open om7057 opened this issue 6 months ago • 6 comments

The Handling Data Migrations section has awkward phrases, long sentences, and minor grammar issues that can be rewritten for better readability and professionalism.

Additionally, the page does not currently cover all supported datasources for migrations in GoFr. Improving this will make the documentation clearer and more complete for users.


To Reproduce

  1. Visit the Handling Data Migrations page.
  2. Read the content carefully.
  3. Notice sentences like these:
- Suppose you manually make changes to your database, and now it's your responsibility to inform other developers to execute them.
+ If you manually change your database, you need to ensure other developers run the same changes too.

- migration.Datasource have the datasources whose migrations are supported…
+ migration.Datasource contains the datasources whose migrations are supported…

Expected Behavior

  • Rewrite unclear or awkward sentences.
  • Use clearer, active voice.
  • Keep the technical meaning intact.
  • Improve grammar and flow.

Proposed Fix

  • Break long sentences into shorter, clearer ones.
  • Fix awkward phrasing.
  • Use a consistent tone and active voice.
  • Polish grammar and punctuation.
  • Extend the documentation to include instructions and details for any supported datasources that are currently missing (e.g., MySQL, PostgreSQL, MSSQL, ScyllaDB).

Notes

I’m happy to work on this and open a PR. Please assign this issue to me.

om7057 avatar Jun 28 '25 07:06 om7057

@om7057, While you are on the track to improve migrations documentation. We would appreciate if you could add up documentation for a few more datasources. If you would edit the issue to tackle that also. we will assign the issue to you.

coolwednesday avatar Jul 01 '25 10:07 coolwednesday

Yes, sure. So should I extend this issue to add for other datasources in similar handling data migrations page.md ?

om7057 avatar Jul 01 '25 10:07 om7057

@coolwednesday I've edited the issue please go through it.

om7057 avatar Jul 01 '25 18:07 om7057

Hey @om7057 , This issue can also handle #1915, hence linking it here. Since you are also contributing under Summer of Code. Let me know if you can still pick up this issue. If yes ! will assign it to you.

Thanks !

coolwednesday avatar Jul 04 '25 08:07 coolwednesday

Hey @coolwednesday if I have to add up just documentation of other datasources in the same page.md then I can contribute to this along with GoFr Summer of Code.

om7057 avatar Jul 05 '25 17:07 om7057

@Umang01-hash can you assign me this issue if its not done then i will be contribute on that

krisp619 avatar Oct 23 '25 09:10 krisp619

Hey @coolwednesday , I'd like to contribute on this issue. Please assign it to me.

PradSharma554 avatar Nov 17 '25 12:11 PradSharma554

Hey @coolwednesday , I'd like to contribute on this issue. Please assign it to me.

Assigned.

coolwednesday avatar Nov 17 '25 12:11 coolwednesday