/bitcoin.org

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Various Backend & Site Docs Updates #823

Merged
merged 4 commits into from Apr 14, 2015

Conversation

Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@harding @saivann
@harding
Contributor

harding commented Apr 12, 2015

Separated into multiple commits for easy review, this pull includes:

  1. Require Jekyll 1.3.0 through Bundle. No more alternative versions allowed if using the Makefile. Require Ruby 2.0.0. Remove a plugin that's no longer necessary in Jekyll >=1.0.0. Remove plugin workarounds that are no longer required on Jekyll 1.3.0. Verified that layout is correct after workaround removal.
  2. Add Makefile targets for make deployment (for build server) and make travis (for Travis CI). Deployment uses only libs from Bundle (i.e. bundle --deployment and also updates libs automatically when possible); otherwise it's identical to make valid. Travis is make all with an extra keep alive previously part of make all.
  3. Add a new plugin for jekyll serve to make /foo serve the file at /foo.html (reducing the amount of instructions we need). Add Makefile target for make preview to launch bundle exec jekyll serve. Major update of site docs to describe installing; I spent several hours repeatedly starting from a bare install of Ubuntu Server and then testing these instructions until a successful build/preview of the site, so hopefully they're bulletproof.

Before merging this commit, I will install RVM and Ruby 2.0.0 on the site build server and translation build server. (I'll also monitor the site build server and actual site uploads for problems immediately after commit. In order to ensure I have time to fix any problems, I'll only consider merging before noon my localtime.)

After this is merged and the site successfully updated, I'll re-merge the developer glossary and also rebase the Bitcoin Core 0.10.1 branch (which should be fine, but why take chances?)

harding added some commits Apr 12, 2015

@harding
Backend: Upgrade To Jekyll 1.3.0 & Remove Workarounds 
* Require in Makefile that everyone use bundle to remove inconsistencies

* Require in Gemfile that everyone use Jekyll 1.3.*

* Require in Gemfile that everyone use Ruby 2.0.0 (already used by
  Travis and most developers)

* Remove workaround _plugin/svg.rb which showed SVG files in `jekyll
  serve` (fixed in Jekyll 1.0.0)

* Remove inconsistent file path workarounds in _plugins/autocrossref.rb
  and _plugins/inline-template.rb
This commit was signed with a verified signature.
@harding harding David A. Harding
GPG key ID: 4B29C30FF29EC4B7 Learn about signing commits
ca7b971
@harding
Backend: Makefile Targets For 'deployment' and 'travis' 
* Set build server to use `make deployment`

* Create Makefile target for 'deployment' to update dependencies if
  necessary

* Set Travis CI to run `make travis`

* Create Makefile target for 'travis' to use additional automation logic
This commit was signed with a verified signature.
@harding harding David A. Harding
GPG key ID: 4B29C30FF29EC4B7 Learn about signing commits
6a42d7b
@harding
Site Docs & Previews: Update Site Building/Previewing Docs 
* New plugin: remove-html-extension falls back to /foo.html when /foo
  isn't found in `jekyll serve` mode.

* New Makefile target: `make preview` runs bundle exec jekyll serve

* Updated site docs to describe installing all required dependencies.
  Fully tested using a new install of Ubuntu Server 14.04.1
This commit was signed with a verified signature.
@harding harding David A. Harding
GPG key ID: 4B29C30FF29EC4B7 Learn about signing commits

Some checks were not successful

1 errored and 1 successful checks
continuous-integration/travis-ci/push — The Travis CI build could not complete due to an error
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
3eee481
@harding
Contributor

harding commented Apr 13, 2015

Oh, I just remembered to diff the _site directory between before and after this change and everything is identical except for /README.md (as expected) and /sitemap.xml (non-deterministic, I guess; everything LGTM in both versions of the file).

@saivann saivann commented on an outdated diff Apr 13, 2015

View full outdated diff
README.md
+
+ ## Slower (but still pretty fast) build and test
+ ENABLED_PLUGINS="events autocrossref" ENABLED_LANGS="en fr" make -i valid
+
+Plugins include:
+
+| Plugin | Seconds | Remote APIs | Used For
+|--------------|---------|----------------|------------------------
+| alerts | 5 | -- | Network alert pages
+| autocrossref | 90 | -- | Developer documentation
+| contributors | 5 | GitHub.com | Contributor listings
+| events | 5 | Meetup.com; Google Maps | Events page
+| glossary | 30 | -- | Developer glossary
+| redirects | 20 | -- | Redirects from old URLs
+| releases | 10 | -- | Bitcoin Core release notes; Download page
+| sitemap | 0 | -- | /sitemap.xml
@saivann

saivann Apr 13, 2015

Contributor

@harding FWIW, the run time for this plugin is influenced by the number of languages enabled. With no language disabled, I can see a 10 seconds difference, in case you'd like to update the number.

@saivann saivann commented on an outdated diff Apr 13, 2015

View full outdated diff
README.md
-You can then copy the output files from _site/ to the root of your web server.
-If you have no web server, run `bundle exec jekyll serve` and visit
-http://127.0.0.1:4000/. This server requires you to add a trailing ".html"
-by hand in your browser address bar.
+(Note: you can use a different default Ruby, but you if you ever change
@saivann

saivann Apr 13, 2015

Contributor

s/but you if you ever/but if you ever/

@saivann saivann commented on the diff Apr 13, 2015

View full changes
Makefile
-## Pre-build tests which, aggregated together, take less than 5 seconds to run on a typical PC
+## Install dependencies (development version)
+install-deps-development:
+ bundle install
+
+## Install dependencies (deployment version)
+install-deps-deployment:
+ bundle install --deployment --without :slow_test
+
@saivann

saivann Apr 13, 2015

Contributor

@harding Is it expected that we have two "install-deps-deployment" Makefile rules?

@harding

harding Apr 13, 2015

Contributor

@saivann one is "-deployment" (used by the build server) and the other is "-development" (used, somewhat unnecessarily, by Travis CI). Travis actually checks out the deps on its own, but I wanted a rule that replicated what it does for local testing.

@saivann

saivann Apr 13, 2015

Contributor

Oh x_X, right

@saivann saivann commented on an outdated diff Apr 13, 2015

View full outdated diff
Gemfile
+## Used on the build server. If you add a package here (like nokogiri)
+## that has non-Gem dependencies (like zlib), please remind the site
+## maintainers that they need to manually update the build server(s)
+## before they commit to master. If `bundle install` can satisify all
@saivann

saivann Apr 13, 2015

Contributor

s/satisify/satisfy/
@saivann
Contributor

saivann commented Apr 13, 2015

This is fantastic, having "jekyll serve" working with clean urls has been a repeated wish with no solution. Kudos for finding a workaround! This will make the build process much more approcheable for new contributors. Everything else also LGTM (except the few small comments above)!
@harding
Site Docs: Grammar Fixes 
Thanks Saïvann!
This commit was signed with a verified signature.
@harding harding David A. Harding
GPG key ID: 4B29C30FF29EC4B7 Learn about signing commits
6ffd230
@harding
Contributor

harding commented Apr 13, 2015

@saivann thanks! Addressed what I think is all the applicable feedback.

In the absence of critical feedback, I'll begin updating the build at translation servers around 11:00 UTC tomorrow; then I'll merge this and re-enable the glossary. When I've done that and confirmed it all works, I'll rebase the 0.10.1 branch.

@harding harding merged commit 6ffd230 into bitcoin-dot-org:master Apr 14, 2015
1 check passed

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

harding added a commit that referenced this pull request Apr 14, 2015

@harding
Merge pull #823: Various Backend & Site Docs Updates
This commit was signed with a verified signature.
@harding harding David A. Harding
GPG key ID: 4B29C30FF29EC4B7 Learn about signing commits
ceaf266
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment