Skip to content

Commit

Permalink
boston chapter specific tweaks to codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
pcai committed Sep 5, 2023
1 parent fc62229 commit 737f14f
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 15 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# The RailsBridge Documentation Project
# The RailsBridge Boston Documentation Project

[![Build Status](https://travis-ci.org/railsbridge/docs.png)](https://travis-ci.org/railsbridge/docs)
[![Ruby](https://github.com/railsbridge-boston/new-docs/actions/workflows/ruby.yml/badge.svg)](https://github.com/railsbridge-boston/new-docs/actions/workflows/ruby.yml)

## Overview

This is a Sinatra app, deployed at <http://docs.railsbridge.org>. The RailsBridge documentation project is home to a few subprojects, including the RailsBridge installfest instructions, which leads students through the various complicated setup instructions for getting Ruby, Rails, Git, etc. installed on their computer (whatever combination of computer, OS, and version they happened to bring to the workshop!), as well as the RailsBridge workshop "Suggestotron" curriculum.
This is a Sinatra app, deployed at <https://docs.railsbridgeboston.org>. The RailsBridge documentation project is home to a few subprojects, including the RailsBridge installfest instructions, which leads students through the various complicated setup instructions for getting Ruby, Rails, Git, etc. installed on their computer (whatever combination of computer, OS, and version they happened to bring to the workshop!), as well as the RailsBridge workshop "Suggestotron" curriculum.

Each subproject (a "site") comprises files stored under the "sites" directory; for instance, the installfest instructions are located at ROOT/sites/en/installfest, while the intro rails curriculum can be found under ROOT/sites/en/intro-to-rails. (The "en" means "English" -- see "Locales" below.)

Expand Down Expand Up @@ -56,13 +56,13 @@ Just make sure the server responds to a locale subdomain: `http://es.railsbridge

### Temporary Testing

Use a `locale` or `l` parameter: `http://docs.railsbridge.org/?l=es`.
Use a `locale` or `l` parameter: `http://docs.railsbridgeboston.org/?l=es`.

Note that in this mode, links are not rewritten, so if they fail you will have to manually add the parameter again.

## Contributing

Check out [CONTRIBUTING.md](CONTRIBUTING.md) to see how to join our [list of contributors](https://github.com/railsbridge/docs/contributors)!
Check out [CONTRIBUTING.md](CONTRIBUTING.md) to see how to join our [list of contributors](https://github.com/railsbridge-boston/docs/contributors)!

## License

Expand All @@ -73,5 +73,5 @@ The code is licensed under an [MIT license](http://opensource.org/licenses/MIT),
## Other Resources

- [StepFile Reference](step_file_reference.md)
- Workshop organizers: See http://docs.railsbridge.org/workshop for example slide decks you can use in your opening/closing presentations.
- Workshop organizers: See http://docs.railsbridgeboston.org/workshop for example slide decks you can use in your opening/closing presentations.

13 changes: 8 additions & 5 deletions lib/doc_page.rb
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def file_name
end

def git_url
"https://github.com/railsbridge/docs/blob/master/sites/#{@locale}/#{site.name}/#{file_name}"
"https://github.com/railsbridge-boston/docs/blob/master/sites/#{@locale}/#{site.name}/#{file_name}"
end

def src_url
Expand All @@ -68,8 +68,11 @@ def body_content
nav(class: "top cf", role: "navigation") {

div(class: "navbar-header cf title") {
a(href: "/") {
span("RailsBridge Boston ", class: "brand")
}
span(" > ")
a(href: "/#{site.name}") {
span("RailsBridge ", class: "brand")
text site_title
}
}
Expand Down Expand Up @@ -120,14 +123,14 @@ def body_content
end
p do
text "If you have a suggestion for improving the docs, please make a "
a "pull request ", href: "https://github.com/railsbridge/docs"
a "pull request ", href: "https://github.com/railsbridge-boston/docs"
text "or "
a "drop us a note ", href: "https://github.com/railsbridge/docs/issues/new"
a "drop us a note ", href: "https://github.com/railsbridge-boston/docs/issues/new"
text "via GitHub Issues (no technical knowledge required)."
end
p do
text "Source: "
url "https://github.com/railsbridge/docs"
url "https://github.com/railsbridge-boston/docs"
end
}
end
Expand Down
2 changes: 1 addition & 1 deletion lib/flags.rb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def content
ul class: 'flags dropdown-menu' do
@locales.each do |locale|
li {
a(href:"http://#{subdomain_for_locale(locale)}.railsbridge.org") {
a(href:"http://#{subdomain_for_locale(locale)}.railsbridgeboston.org") {
img src: image_for_locale(locale)
}
}
Expand Down
6 changes: 3 additions & 3 deletions sites/docs/docs.step
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
message <<MARKDOWN
This site is maintained by RailsBridge volunteers. If you find something that could be improved, please make a [pull request](https://github.com/railsbridge/docs) or [drop us a note](https://github.com/railsbridge/docs/issues/new) via GitHub Issues (no technical knowledge required).
This site is maintained by RailsBridge volunteers. If you find something that could be improved, please make a [pull request](https://github.com/railsbridge/docs) or [drop us a note](https://github.com/railsbridge-boston/docs/issues/new) via GitHub Issues (no technical knowledge required).

Going through this curriculum on your own? You can get help on <a href="http://discourse.bridgefoundry.org/c/railsbridge-help" target="_blank">our Discourse forum</a>. (Volunteers to answer questions always needed, too!)
MARKDOWN
Expand Down Expand Up @@ -83,9 +83,9 @@ If you're not doing those two things, you can totally still use the site, we jus

### I want to help, but I don't know how.

First, [make a GitHub account](https://github.com). Then, [create an issue](https://github.com/railsbridge/docs/issues) with the idea you have. We'll help you turn it into reality (assuming it's in line with our lofty goals :D).
First, [make a GitHub account](https://github.com). Then, [create an issue](https://github.com/railsbridge-boston/docs/issues) with the idea you have. We'll help you turn it into reality (assuming it's in line with our lofty goals :D).

Don't know what you could work on? Browse the [issues list](https://github.com/railsbridge/docs/issues) and the [Volunteer Opportunities List](https://github.com/railsbridge/docs/wiki/RailsBridge-Volunteer-Opportunities). Those have lots of ideas.
Don't know what you could work on? Browse the [issues list](https://github.com/railsbridge-boston/docs/issues) and the [Volunteer Opportunities List](https://github.com/railsbridge/docs/wiki/RailsBridge-Volunteer-Opportunities). Those have lots of ideas.


### I have a different question about RailsBridge.
Expand Down

0 comments on commit 737f14f

Please sign in to comment.