-
Notifications
You must be signed in to change notification settings - Fork 629
Home
Much like a wiki, ruby-lang.org is editable by its users. Unlike a wiki, the edition does not take place on the website itself, but here, on Github. If you don't know much about git, head to the official website or the very good and to-the-point Github help.
The overhaul process is fairly straightforward:
- find something to edit/fix/update
- propose your change here
- wait for review and approval
The website is updated on a regular basis and your edits will show up when a team member triggers a new deployment.
If there is something you want to edit, the process is rather simple. First, create a Github account and log in. Then, it depends on whether you want to do a quick edit or something more involved.
Simple edits may be performed directly on Github, using the "Edit" button while browsing the file you want to edit:
- head to the repository containing the website code
- browse the files to display the one you want to edit (a description of the project structure is available here
- click on "Edit" and make your changes
- When everything looks fine, click the "Propose File Change" button
- Provide a good rational for your request, and click on "Send Pull Request" to complete the process
A new pull-request will be created with your changes. A member of the editorial team will review your request and eventually merge the edits in if all is good. If not, you will most likely receive some insights through a comment on your pull-request and will be automatically notified.
If you plan to perform regular and/or large-scale edits, you may want to clone the repository on your local machine instead:
- head to the repository containing the website code
- follow the instruction on the README (
git cloneand installation guidelines) - Make your changes on a topic branch, using maintainer-friendly policies
- Follow the Github guide on pull-request to create a new request
Please mention the affected translation in the commit message. Examples:
"Fix typo on en/about""Add latest news posts (de)"
When you find an error on a translated site that is not language specific --like for example a typo in a code snippet-- consider opening an issue or pull request for the English site, that essentially serves as "master" for the various translations.
When translating pages and news posts the directory structure and filenames of the English site should be kept. This makes it easier to find and compare corresponding pages and news posts.