Skip to content

Commit 7cbe100

Browse files
committed
docs: improve README for newcomers and contributors
- Add quick start guide with clear prerequisites and setup steps - Reorganize content with better structure and visual hierarchy - Emphasize testing requirements before PR submission - Move advanced Heroku deployment section to end - Clarify language guidelines for global developer audience - Remove duplicate sections and improve flow
1 parent 54fcd07 commit 7cbe100

1 file changed

Lines changed: 85 additions & 86 deletions

File tree

README.md

Lines changed: 85 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -5,129 +5,128 @@ www.ruby-lang.org
55

66
[![Build Status](https://github.com/ruby/www.ruby-lang.org/workflows/ci/badge.svg)](https://github.com/ruby/www.ruby-lang.org/actions?query=branch%3Amaster)
77

8-
This is the [Jekyll](http://www.jekyllrb.com/) source of
9-
the [www.ruby-lang.org](https://www.ruby-lang.org/) website.
8+
This is the [Jekyll](http://www.jekyllrb.com/) source code for the official [Ruby programming language website](https://www.ruby-lang.org/).
109

11-
## How to Contribute?
10+
## 🚀 Quick Start
1211

13-
You can contribute by reporting errors or suggesting improvements.
14-
Just open an issue or pull request.
12+
**First time contributing?** Welcome! This guide will help you get the website running locally in just a few steps.
1513

16-
This is a big project with many translations involved.
17-
Please help us stay on top of things by following our
18-
[guidelines for contributors](https://github.com/ruby/www.ruby-lang.org/wiki).
14+
### Prerequisites
1915

20-
## Get It!
16+
- **Ruby** (latest stable version recommended) - [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
17+
- **Git** - [Install Git](https://git-scm.com/downloads)
2118

22-
Bundler will take care of the dependencies, so unless you
23-
already have done so, you might need to install bundler with:
19+
### Get It Running
2420

25-
``` sh
26-
gem install bundler
27-
```
21+
1. **Install Bundler** (if you haven't already):
22+
```sh
23+
gem install bundler
24+
```
2825

29-
Then clone the repository and install the dependencies:
26+
2. **Clone and setup the project**:
27+
```sh
28+
git clone https://github.com/ruby/www.ruby-lang.org.git
29+
cd www.ruby-lang.org/
30+
bundle config set --local without production
31+
bundle install
32+
```
3033

31-
``` sh
32-
git clone https://github.com/ruby/www.ruby-lang.org.git
33-
cd www.ruby-lang.org/
34-
bundle config set --local without production
35-
bundle install
36-
```
34+
3. **Start the development server**:
35+
```sh
36+
bundle exec rake serve
37+
```
3738

38-
## Make Changes
39+
4. **View the website**: Open [http://localhost:4000/](http://localhost:4000/) in your browser
3940

40-
Making changes is easy:
41-
just locate the Markdown source of the page you want to improve,
42-
then make your changes or add content.
41+
⏱️ **Note:** The initial build takes several minutes. Make some tea! 🍵
4342

44-
If you plan to submit a pull request or want to preview your changes
45-
on Heroku, you need to
43+
## 🤝 How to Contribute
4644

47-
* create a topic branch,
48-
* commit your changes to this branch.
45+
### Quick Fixes
46+
- **Found a typo?** Just edit the Markdown file and submit a pull request!
47+
- **Broken link?** Open an issue and we'll fix it quickly
48+
- **Translation error?** Check our [translation guidelines](https://github.com/ruby/www.ruby-lang.org/wiki)
4949

50-
See the [project's wiki][wiki] for some guidelines on how
51-
your commits and PRs should look like.
50+
### Making Changes
5251

53-
## Preview Your Changes
52+
1. **Find the content**: Website pages are in Markdown format in language-specific folders (e.g., `en/`, `ja/`, `es/`)
53+
2. **Create a branch**: `git checkout -b fix-typo-in-getting-started`
54+
3. **Make your changes**: Edit the Markdown files
55+
4. **Test as you go**: Run `bundle exec rake serve` to preview your changes
56+
5. **Run the test suite**: Before submitting, ensure all tests pass (see Testing section below)
57+
6. **Submit**: Open a pull request with a clear description
5458

55-
### Preview Locally
59+
**New to open source?** Check out [First Contributions](https://github.com/firstcontributions/first-contributions) for a beginner-friendly guide.
5660

57-
Generate the website with
61+
## 🛠️ Development
5862

59-
``` sh
60-
bundle exec rake build
61-
```
62-
63-
Then start a local web server with
63+
### Local Development
64+
```sh
65+
# Quick development server (faster rebuilds)
66+
bundle exec jekyll serve --watch --future --incremental
6467

65-
``` sh
66-
bundle exec rake serve
68+
# Full build (for testing)
69+
bundle exec rake build
6770
```
6871

69-
Open [http://localhost:4000/](http://localhost:4000/)
70-
in your browser to access the preview.
72+
### Testing Your Changes
7173

72-
**Note:** The build of the site will take several minutes.
74+
**Important**: Always run the full test suite before submitting a pull request:
7375

74-
Alternatively, you can use Jekyll directly.
75-
76-
```
77-
bundle exec jekyll serve --watch --future --incremental
76+
```sh
77+
bundle exec rake lint # Check markdown formatting
78+
bundle exec rake check:markup # Validate HTML output
79+
bundle exec rake check:links # Check for broken links (requires local server)
7880
```
7981

80-
If your draft uses future date, you may want to use `--future` option.
81-
82-
### Preview on Heroku
82+
You can run these tests while developing to catch issues early.
8383

84-
In case a build is not possible on your local machine
85-
or you want to test your changes under production conditions
86-
you can also create a preview on Heroku.
84+
## 🌐 Translations
8785

88-
* Sign up for [Heroku](http://www.heroku.com) if you do not have
89-
an account yet.
86+
This project supports multiple languages! Each language has its own folder:
87+
- `en/` - English (base language)
88+
- `ja/` - Japanese
89+
- `es/` - Spanish
90+
- `fr/` - French
91+
- And many more...
9092

91-
* Install the [Heroku Toolbelt](https://toolbelt.heroku.com).
93+
**Want to help translate?** See our [translation guide](https://github.com/ruby/www.ruby-lang.org/wiki) for detailed instructions.
9294

93-
* Unless you already have, `cd` into your local working copy of this repo.
95+
## 📝 Content Guidelines
9496

95-
* Create a preview app on Heroku using the custom buildpack:
97+
- **Keep it simple**: Write for a global audience of developers with varying English proficiency
98+
- **Be clear**: Use straightforward language that's easy to understand
99+
- **Stay current**: Update version numbers and examples regularly
100+
- **Test your changes**: Always preview locally before submitting
96101

97-
``` sh
98-
heroku login
99-
heroku create --buildpack https://github.com/ruby/heroku-buildpack-www-ruby-lang.git
100-
```
102+
## 🔧 Heroku Preview (Advanced)
101103

102-
* Push your feature branch:
104+
If you can't build locally or want to test under production conditions:
103105

104-
``` sh
105-
git push heroku feature_branch:master
106-
```
106+
1. **Setup Heroku**: Sign up at [heroku.com](http://www.heroku.com) and install [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
107107

108-
To create a preview of the master branch:
108+
2. **Create preview app**:
109+
```sh
110+
heroku login
111+
heroku create --buildpack https://github.com/ruby/heroku-buildpack-www-ruby-lang.git
112+
```
109113

110-
``` sh
111-
git push heroku master
112-
```
114+
3. **Deploy your branch**:
115+
```sh
116+
git push heroku your-branch-name:master
117+
heroku open
118+
```
113119

114-
Open the preview in your browser with `heroku open` or
115-
retrieve the preview URL using `heroku info` and open it in your browser.
120+
## 💬 Getting Help
116121

122+
- **Questions?** Join our [Gitter chat](https://gitter.im/ruby/www.ruby-lang.org)
123+
- **Found a bug?** [Open an issue](https://github.com/ruby/www.ruby-lang.org/issues)
124+
- **Need more info?** Check the [project wiki](https://github.com/ruby/www.ruby-lang.org/wiki)
117125

118-
## Testing
119-
120-
Besides generating and previewing the site
121-
you can perform additional tests with these tasks:
122-
123-
``` sh
124-
bundle exec rake lint # run linter on markdown files
125-
bundle exec rake check:markup # check markup for all generated pages
126-
bundle exec rake check:links # check for 404's (needs a running local server)
127-
```
126+
## 📚 More Information
128127

129-
## More Information
128+
For detailed contribution guidelines, coding standards, and project structure, see our [wiki](https://github.com/ruby/www.ruby-lang.org/wiki).
130129

131-
For more information see the [wiki][wiki].
130+
---
132131

133-
[wiki]: https://github.com/ruby/www.ruby-lang.org/wiki
132+
**Thank you for helping make Ruby's website better for everyone!** 🎉

0 commit comments

Comments
 (0)