Page MenuHomePhabricator

Create a new doc about managing and sharing files in Toolforge
Closed, ResolvedPublic

Description

There is existing information in several docs about the file directory structure within Tool Accounts, file permissions, and how to work with files as a tool maintainer. I think there's enough content that this topic could have its own page, which would make the Tool Accounts page a bit less overwhelming, while still grouping information together in a way that makes sense.

Suggested content to move out of existing pages and into a new page:

For tips and doc templates to help you get started writing a new doc, visit https://www.mediawiki.org/wiki/Documentation/Toolkit

Event Timeline

Frostly triaged this task as High priority.
Frostly added a project: User-Frostly.
Frostly moved this task from Backlog to In progress on the User-Frostly board.
Frostly lowered the priority of this task from High to Medium.Oct 1 2023, 8:01 PM
Frostly moved this task from In progress to Backlog on the User-Frostly board.

@Frostly Removing task assignee as this open task has been assigned for more than two years - See the email sent to task assignee on 2025-11-25.
Please assign this task to yourself again if you still realistically [plan to] work on this task - it would be welcome! :)
If this task has been resolved in the meantime, or should not be worked on by anybody ("declined"), please update its task status via "Add Action… 🡒 Change Status".
Also see https://www.mediawiki.org/wiki/Bug_management/Assignee_cleanup for tips how to best manage your individual work in Phabricator. Thanks!

Pppery added subscribers: Cappybaraa, Pppery.

Resetting assignee since progress seems to have stalled

Hi! there I'd like to work on this task if it's still available.

I have reviewed the scope and understand that the goal is to consolidate existing documentation about Toolforge file management, directory structure, file permissions, and related best practices into a dedicated page, while reducing complexity on the Tool Accounts page. I'm also happy to follow the Documentation Toolkit guidelines and coordinate on the structure if there are any preferences.

Please assign the task to me if it's available. Thanks!

apaskulin subscribed.

Hi @Tejinderk.2004, I've gone ahead and assigned the task to you. Thank you!

Hey there ! here's an update on the task.

Created an initial draft of the new page:
https://wikitech.wikimedia.org/wiki/Help:Toolforge/Managing_and_sharing_files

Current sections:

  • Introduction
  • Before you start
  • Understanding Toolforge storage
  • File permissions
  • File transfers
  • File sharing

Still to do:

  • Troubleshooting
  • Review and cleanup of migrated content
  • Cross-linking from existing pages

I've started reorganizing the content as a Diátaxis-style how-to guide, with the goal of consolidating file management, storage, permissions, and sharing guidance that is currently spread across multiple pages.

Feedback on the page structure and overall direction would be appreciated before I continue migrating the remaining content.

Thanks for your work on this, @Tejinderk.2004! The draft you created looks great! The structure does a great job focusing on the types of tasks that users will need to perform, and the "Before you start" section provides helpful context.

I made some small adjustments to the headings levels; because wiki page titles are h1s, headings in the page body need to start with h2. I also removed the "Introduction" heading to create a conventional lead section.

For the code samples, we typically use https://wikitech.wikimedia.org/wiki/Template:Codesample to create a more traditional block-style format with syntax highlighting.

But other than those small things, the structure and overall direction are looking really good. Thanks again for taking this on!

Thank you for capturing this information! A small suggestion is, a section about backing up files elsewhere (for anything that can't be re-generated). There is a similar page to yours here, with the supplemental info: https://wikitech.wikimedia.org/wiki/Help:Toolforge/Tool_accounts

Heyy!

I'm currently working on this task to consolidate Toolforge file management documentation into a new page, ''Managing and sharing files in Toolforge''. I've moved and reorganized content from the existing documentation pages following the suggested structure and the Diátaxis approach.

However, I'm running into a Wikitech AbuseFilter issue while editing the page. Even when adding relatively small sections (for example, the "Common problems" and "Best practices" sections containing existing documentation and command examples), my edits are blocked with the message "common vandalistic edits."
I've tried breaking the changes into smaller edits, but I'm still having trouble saving the page. Could someone help me determine what is triggering the filter, or suggest a better way to make these documentation updates?

I'd appreciate any guidance. Thanks! Also I'm happy to provide the wikitext diff or split the changes differently if that would help.

Hi! Sorry to hear you're encountering that AbuseFilter issue. I filed T429511 to request that your user account be marked as 'confirmed user' so that hopefully you'll be able to edit without being blocked. Thanks for your patience and for your doc contributions!

@Tejinderk.2004 - your user rights have been adjusted. Please log out of Wikitech and log back in, then attempt to make the edits you were making before. I hope you should be able to do so with no issues and without being blocked! However, if you encounter AbuseFilter issues again, please reopen T429511 and add a comment about what you are encountering. Thanks again!

Hi @apaskulin , @TBurmeister , and @BLiviero-WMF,

I've completed the task! This was my first Phabricator contribution, and I couldn't have asked for better mentors for it. Thank you all so much for your guidance, active responses, and patience throughout the process—it made getting started much less intimidating.

I've created the new documentation page for Managing and sharing files and also updated the original source pages with references and links to the new page wherever it seemed appropriate, to help with navigation and avoid duplication.

When you have a chance, I'd really appreciate it if you could take a look and let me know if there are any improvements or changes you'd recommend.

Thanks again for all your help and support!

I reviewed the page, and it looks excellent. Great work! I've gone ahead and added the page to the Toolforge navigation so tool maintainers can discover and use it. It's going to be a big help to tool maintainers, especially for those who are new to tools. Thank you so much, @Tejinderk.2004! We really appreciate your contributions!