Page MenuHomePhabricator
Create Task
Maniphest T375642

Write documentation about how the app is deployed in Cloud VPS and Toolforge
Closed, ResolvedPublic
Actions

Description

I was trying to debug T375618: outreachdashboard.wmflabs.org down 2024-09-25 but I did not find any information about how/where the dashboard was deployed, and it took me a while to find the corresponding Cloud VPS project and Toolforge tool.

I added the following info to https://phabricator.wikimedia.org/project/manage/1052/:

The app runs in Cloud VPS, in the globaleducation project.

There is also the Toolforge tool wikiedudashboard which is running the code from WikiEduDashboardTools.

It would be very useful to have a wiki page somewhere with more complete and accurate information about the deployment, how to debug issues, restart the app, etc.

Related Objects

Event Timeline

fnegri created this task.Sep 25 2024, 3:47 PM
Restricted Application added subscribers: Base, Aklapper. · View Herald TranscriptSep 25 2024, 3:47 PM
Peachey88 added a project: Documentation.Nov 12 2024, 10:04 AM
Ragesoss subscribed.Nov 12 2024, 6:21 PM

I think this would make a great task to roll into the (hopefully) upcoming Outreachy project: https://phabricator.wikimedia.org/T374390

We have a fair amount of documentation in the codebase, but it's spread out and not geared towards letting others easily hop in and fix production problems.

empty-codes mentioned this in T378119: Outreachy Round 29: Proposal for ‘Improve observability of Wiki Education Dashboard’ project..Dec 6 2024, 1:39 PM
empty-codes claimed this task.Jan 2 2025, 9:40 PM
empty-codes closed this task as Resolved.Jan 2 2025, 9:44 PM

An 'Admin Guide' containing an overview of the Dashboard infrastructure, including servers, tools, dependencies, and troubleshooting resources has been created and linked to the project's meta wiki page. Closing the task as completed.

fnegri added a comment.Jan 3 2025, 1:49 PM

@empty-codes great job, thank you!

fnegri awarded a token.Jan 3 2025, 1:50 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits