Skip to content

docs: add Toolforge deployment guide for Scribe-Server#63

Open
axif0 wants to merge 3 commits into
scribe-org:mainfrom
axif0:documentation
Open

docs: add Toolforge deployment guide for Scribe-Server#63
axif0 wants to merge 3 commits into
scribe-org:mainfrom
axif0:documentation

Conversation

@axif0
Copy link
Copy Markdown
Member

@axif0 axif0 commented May 18, 2026

Contributor checklist

  • This pull request is on a separate branch and not the main branch
  • I have ran the ./pre-commit executable as well as make lint and have fixed all reported issues

Description

Adds a step-by-step deployment guide for hosting Scribe-Server on Wikimedia's Toolforge platform.

Related issue

@axif0 axif0 requested review from DeleMike and andrewtavis May 18, 2026 15:57
@github-actions
Copy link
Copy Markdown

Thank you for the pull request! 💙🩵

The Scribe-Server team will do our best to address your contribution as soon as we can. The following are some important points:

  • Those interested in developing their skills and expanding their role in the community should read the mentorship and growth section of the contribution guide
  • If you're not already a member of our public Matrix community, please consider joining!
    • We'd suggest that you use the Element client as well as Element X for a mobile app
    • Join the General and Data rooms once you're in
  • Also consider attending our bi-weekly Saturday developer syncs!
    • Details are shared in the General room on Matrix each Wednesday before the sync
    • It would be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

@github-actions
Copy link
Copy Markdown

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

  • Tests for changes have been written and the continuous integration (CI) workflows within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@axif0
Copy link
Copy Markdown
Member Author

axif0 commented May 18, 2026

@DeleMike, feel free to add or commit if you have anything to update. I've added everything I can recall from memory.

@DeleMike
Copy link
Copy Markdown
Collaborator

Yeah, I will check it and revert. Thanks ✨🙌🏾

@andrewtavis
Copy link
Copy Markdown
Member

This is amazing, @axif0! Thanks so much for this :) The commit above just does some minor edits to align the docs with the new docs we have written 😊

@DeleMike, feel free to review when you can and merge once all's ready!

Copy link
Copy Markdown
Collaborator

@DeleMike DeleMike left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @axif0 for the PR!

I corrected a slight mix-up in the former line chmod +x update_data.sh and some other related lines. I changed it to use start-script.sh where necessary.

I also expanded the Python setup and possible data fetch using update_data.sh

@DeleMike
Copy link
Copy Markdown
Collaborator

Hi @andrewtavis, can you do a final check? thanks. All LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Toolforge Documentation in scribe-server

3 participants