https://github.com/ruby/docs.ruby-lang.org

Source of the docs.ruby-lang.org site
https://github.com/ruby/docs.ruby-lang.org

ruby

Last synced: 5 days ago
JSON representation

Source of the docs.ruby-lang.org site

• Host: GitHub
• URL: https://github.com/ruby/docs.ruby-lang.org
• Owner: ruby
• Created: 2013-05-31T05:50:01.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2025-01-28T00:21:26.000Z (14 days ago)
• Last Synced: 2025-01-30T10:09:11.404Z (12 days ago)
• Topics: ruby
• Language: Ruby
• Homepage: https://docs.ruby-lang.org
• Size: 511 KB
• Stars: 48
• Watchers: 13
• Forks: 26
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docs.ruby-lang.org

## WARNING

* This repository is inconsistent with production.

* Use only `bundle exec cap production deploy`. Do not use `ansible-playbook`.

## Platform Environment

* We use `capistrano` for deployments.

* Currently hosted on AWS EC2 Tokyo region

  * All applications run as `rurema` user.

* Periodic tasks run in systemd timer (`systemctl list-timers`)

## Files and Directories

* rurema-search: `/var/rubydoc`

* docs.ruby-lang.org: `/var/www/docs.ruby-lang.org`

* nginx configuration: `/etc/nginx/sites-available/docs.ruby-lang.org`

## Files need to backup

* old statically generated contents (old versions need to copy from old server): `/var/www/docs.ruby-lang.org/shared/public/{en,ja}/*`

  * Versioned contents of `ja` are from  since 2024-06-06.

* Fastly API Key: `/home/rurema/.docs-fastly`

* Slack webhook URL: `/etc/systemd/system/notify-to-slack.env`

* Mackerel API Key and plugin configurations: `/etc/mackerel-agent/mackerel-agent.conf`

## Related repos

* https://github.com/ruby/rurema-search

* https://github.com/rurema/generated-documents

## Previewing `public` directory locally

1. Install dependencies: `bundle install`

2. Run:

  ```

  bin/server

  ```

3. Open http://localhost:8000/

## Production Environment

### Capstrano

```

cap production deploy

```

### /etc/nginx/sites-available/docs.ruby-lang.org

Manual sync with `conf/docs.ruby-lang.org`.

Because ansible playbooks are outdated.

### /etc/mackerel-agent/mackerel-agent.conf

Install `mackerel-check-plugins` too.

Add/Modified:

```

[filesystems]

ignore = "/dev/loop*"

[plugin.checks.fileage-bc-setup-all]

command = ["check-file-age", "-i", "-w", "90000", "-c", "172800", "-f", "/run/docs.ruby-lang.org/bc-setup-all.updated"]

[plugin.checks.fileage-bc-static-all]

command = ["check-file-age", "-i", "-w", "90000", "-c", "172800", "-f", "/run/docs.ruby-lang.org/bc-static-all.updated"]

[plugin.checks.fileage-rdoc-static-all]

command = ["check-file-age", "-i", "-w", "90000", "-c", "172800", "-f", "/run/docs.ruby-lang.org/rdoc-static-all.updated"]

[plugin.checks.fileage-update-rurema-index]

command = ["check-file-age", "-i", "-w", "90000", "-c", "172800", "-f", "/run/docs.ruby-lang.org/update-rurema-index.updated"]

```