WikiEduDashboard icon indicating copy to clipboard operation
WikiEduDashboard copied to clipboard

Test, improve and document the dev data population script

Open ragesoss opened this issue 7 years ago • 26 comments

We have a script that getting reasonable test data into a dev environment, by creating a few courses of different types, campaigns, etc.

It doesn't yet do the pulling of data from Wikipedia, and it isn't documented from the setup docs.

ragesoss avatar Oct 18 '17 18:10 ragesoss

@ragesoss I think you wrote this script a while back.

psinghal20 avatar Sep 09 '18 15:09 psinghal20

True! I completely forgot about that, and I don't know that it's been put to much use. I changed task title, as it would be good to get feedback on how well it works and how it could be improved, and make sure the relevant docs point to it.

The script is setup/populate_dashboard.rb, and it can be run with rake dev:populate.

ragesoss avatar Sep 10 '18 20:09 ragesoss

Would like to pick this up? Is this still needed?

manisha-A avatar Oct 11 '18 13:10 manisha-A

Yes, please go for it. The idea is that running the script should be pretty quick, but should leave you with representative data to be able to access or test as much of the app's functionality as possible.

ragesoss avatar Oct 11 '18 14:10 ragesoss

@ragesoss can I include this in GCI? The script is already there, it needs to be tested and improved, if there's the scope for it and document the whole thing, right?

AmitJoki avatar Nov 16 '19 06:11 AmitJoki

@AmitJoki yep, perfect.

ragesoss avatar Nov 18 '19 22:11 ragesoss

Hello, that's me again :-). What is "improve"? Tasks in GCI need to have clear criteria, so students know what is expected from them and what is and is not acceptable. I'd maybe split the task into several smaller tasks, such as "make the script do X", then "make the script do Y" and "document the script". All of those tasks can be done by different students - it doesn't have to be one large task.

urbanecm avatar Nov 19 '19 19:11 urbanecm

@ragesoss @bwreid per @urbanecm 's comments, the generic word "improve" needs to be elaborated more so we can quantify the work done. Do you have any particular improvement in mind that could be done or is it optional?

AmitJoki avatar Nov 20 '19 02:11 AmitJoki

Ping? :-)

urbanecm avatar Dec 01 '19 13:12 urbanecm

@ragesoss I will reword this task to just test the existing script and if we have a more objective idea of how to improve the same, I'll add another task for the same. Is that okay @urbanecm?

AmitJoki avatar Dec 02 '19 13:12 AmitJoki

Perfect for me :)

urbanecm avatar Dec 02 '19 13:12 urbanecm

@urbanecm done :)

AmitJoki avatar Dec 02 '19 13:12 AmitJoki

Thanks! A question, which submission should the students submit into the repo?

urbanecm avatar Dec 02 '19 13:12 urbanecm

The tests and documentation can be submitted as a pull request to this repository. @urbanecm

AmitJoki avatar Dec 03 '19 03:12 AmitJoki

Hello, this issue is still open. Can you please specify what need to be done here, as I am a new contributor, willing to contribute in this repo.

ajitesh13 avatar May 26 '20 15:05 ajitesh13

@Ajitesh13 for this issue, you should run the data population script (rake dev:populate), report any errors, and then explore the courses it added to the Dashboard and then document which features of the system that you would need to add more/different data in order to test locally.

ragesoss avatar May 26 '20 15:05 ragesoss

Thanks @ragesoss for the insights, I will let you know, if I faced any difficulty.

ajitesh13 avatar May 28 '20 05:05 ajitesh13

@ragesoss Where will I write the documentation to open a PR? Is it in docs/user_roles.md#populating-initial-courses

ajitesh13 avatar Jun 25 '20 07:06 ajitesh13

@Ajitesh13 the documentation for opening a PR is in the CONTRIBUTING file: https://github.com/WikiEducationFoundation/WikiEduDashboard/blob/master/CONTRIBUTING.md#pull-request-process

ragesoss avatar Jun 25 '20 17:06 ragesoss

hey @ragesoss would like to contribute to it.

varu567 avatar Nov 19 '23 06:11 varu567

@varu567 cool, go for it. let us know you have any questions.

ragesoss avatar Nov 20 '23 18:11 ragesoss

Hi @ragesoss,

I hope this message finds you well. I'm interested in joining the WikiEducationFoundation Slack channel to stay informed and contribute to the discussions. Could you please add me to the channel?

Looking forward to being a part of the community.

Nikuunj avatar Nov 29 '23 05:11 Nikuunj

@Nikuunj please give me your email address so I can send an invite.

ragesoss avatar Nov 29 '23 18:11 ragesoss

@ragesoss email - [email protected]

Nikuunj avatar Nov 30 '23 15:11 Nikuunj

Hi @ragesoss is the issue still open Id like to solve it also I m interested in joining the WikiEducationFoundation Slack so to contribute further. [email protected]

Shrutikaghule avatar Dec 26 '23 19:12 Shrutikaghule

@Shrutikaghule yes, this is one that always has room for further testing and improvement. I sent invite ... I assume "email-" is not part of your email address.

ragesoss avatar Jan 02 '24 17:01 ragesoss