WikiEduDashboard
WikiEduDashboard copied to clipboard
Test, improve and document the dev data population script
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 I think you wrote this script a while back.
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
.
Would like to pick this up? Is this still needed?
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 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 yep, perfect.
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.
@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?
Ping? :-)
@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?
Perfect for me :)
@urbanecm done :)
Thanks! A question, which submission should the students submit into the repo?
The tests and documentation can be submitted as a pull request to this repository. @urbanecm
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 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.
Thanks @ragesoss for the insights, I will let you know, if I faced any difficulty.
@ragesoss Where will I write the documentation to open a PR? Is it in docs/user_roles.md#populating-initial-courses
@Ajitesh13 the documentation for opening a PR is in the CONTRIBUTING file: https://github.com/WikiEducationFoundation/WikiEduDashboard/blob/master/CONTRIBUTING.md#pull-request-process
hey @ragesoss would like to contribute to it.
@varu567 cool, go for it. let us know you have any questions.
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 please give me your email address so I can send an invite.
@ragesoss email - [email protected]
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 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.