From 737f14f31e139e31c06798bfc15eeb860bd9f73e Mon Sep 17 00:00:00 2001 From: Peter Cai <222655+pcai@users.noreply.github.com> Date: Wed, 23 Aug 2023 18:41:59 +0000 Subject: [PATCH] boston chapter specific tweaks to codebase --- README.md | 12 ++++++------ lib/doc_page.rb | 13 ++++++++----- lib/flags.rb | 2 +- sites/docs/docs.step | 6 +++--- 4 files changed, 18 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6eeccd756..cfb1e6723 100644 --- a/README.md +++ b/README.md @@ -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 . 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 . 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.) @@ -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 @@ -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. diff --git a/lib/doc_page.rb b/lib/doc_page.rb index 0848933b1..d1e982cc4 100644 --- a/lib/doc_page.rb +++ b/lib/doc_page.rb @@ -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 @@ -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 } } @@ -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 diff --git a/lib/flags.rb b/lib/flags.rb index 1e6372d31..c5f38c8b8 100644 --- a/lib/flags.rb +++ b/lib/flags.rb @@ -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) } } diff --git a/sites/docs/docs.step b/sites/docs/docs.step index dba228e3a..19a046f75 100644 --- a/sites/docs/docs.step +++ b/sites/docs/docs.step @@ -1,5 +1,5 @@ message <our Discourse forum. (Volunteers to answer questions always needed, too!) MARKDOWN @@ -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.