controllo

.env.example

@@ -1,3 +1 @@
-UPDATE_TOKEN=test
-API_USER=
-API_PASS=
+GITHUB_API_TOKEN=

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,20 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Problems/questions/bugs about Git program
+    url: https://git-scm.com/community
+    about: Start a discussion on the community mailing list.
+
+  - name: Problems about Git for Windows program
+    url: https://github.com/git-for-windows/git/issues
+    about: Report problems with the Git for Windows program.
+
+  - name: Git documentation (man/help pages)
+    url: https://git-scm.com/community
+    about: >
+      The Git documentation under https://git-scm.com/docs is imported
+      from the Git project itself. Any content problems or suggestions
+      should be reported there.
+
+  - name: Pro Git 2 book content
+    url: https://github.com/progit/progit2/issues
+    about: Report problems with the ProGit 2 book content.

.github/ISSUE_TEMPLATE/downloads.md

@@ -0,0 +1,32 @@
+---
+name: "Downloads on git-scm not working"
+about: "If you are experiencing problems downloading Git from git-scm.com"
+---
+
+<!---
+Please follow the instructions below.
+An issue properly explained is solved much faster!
+-->
+
+<!--- Provide a brief summary of the issue in the issue title -->
+
+### Which download is failing?
+
+<!--- Tell us in which page and version is the download broken -->
+
+### Problem
+
+<!--- Explain the problem clearly -->
+
+### Operating system and browser
+
+<!--- Which operating system and browser are you using? -->
+
+### Steps to reproduce
+
+<!--- Provide a detailed list of steps. -->
+<!--- In the rare cases where this is not possible, we will accept a detailed set of instructions. -->
+
+### Other details
+
+<!--- Include as many relevant details you may find relevant -->

.github/ISSUE_TEMPLATE/ui.md

@@ -0,0 +1,34 @@
+---
+name: "git-scm user interface broken"
+about: "git-scm.com user interface is not working"
+---
+
+<!---
+Please follow the instructions below.
+An issue properly explained is solved much faster!
+
+Only report problems with the git-scm.com site's JavaScript, CSS or content that doesn't seem to be doing its job correctly!
+-->
+
+<!--- Provide a brief summary of the issue in the issue title -->
+
+### URL for broken page
+
+<!--- Give us the link to the broken page -->
+
+### Problem
+
+<!--- Explain the problem clearly -->
+
+### Operating system and browser
+
+<!--- Which operating system and browser are you using? -->
+
+### Steps to reproduce
+
+<!--- Provide a detailed list of steps. -->
+<!--- In the rare cases where this is not possible, we will accept a detailed set of instructions. -->
+
+### Other details
+
+<!--- Include as many relevant details you may find relevant -->

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+## Changes
+
+<!-- List the changes this PR makes. -->
+
+-
+
+## Context
+
+<!-- Explain why you're making these changes. -->

.gitignore

@@ -1,20 +1,15 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 #
 # If you find yourself ignoring temporary files generated by your text editor
 # or operating system, you probably want to add a global ignore instead:
 #   git config --global core.excludesfile ~/.gitignore_global
 
-.rbenv-version
 .env
 
 # Ignore bundler config
 /.bundle
-/bin
 /vendor/gems
 
-
-config/database.yml
-
 # Ignore the default SQLite database.
 /db/*.sqlite3*
 
@@ -30,3 +25,11 @@ config/database.yml
 *.swo
 
 /public/*.zip
+
+node_modules/
+
+# Ignore byebug history
+.byebug_history
+
+# RSpec
+spec/examples.txt

.rspec

@@ -1 +1 @@
---color
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,26 @@
+require:
+  - rubocop-rails
+
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+    - config/rails.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Performance:
+  enabled: true
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - db/schema.rb
+
+Rails/HelperInstanceVariable:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+GitHub/InsecureHashAlgorithm:
+  Enabled: false

.ruby-version

@@ -1 +1 @@
-2.1.2
+2.7.2

.stylelintrc.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "stylelint-config-primer"
+  ]
+}

.travis.yml

@@ -1,6 +1,16 @@
 language: ruby
-script: 'script/travis-ci'
-rvm:
-  - 2.1.2
+
+before_script:
+  - bundle exec rake db:create db:schema:load
+
+bundler_args: --without development production --jobs=3 --retry=3
+
+cache:
+  bundler: true
+
 notifications:
   email: false
+
+script:
+  - bundle exec rubocop -P
+  - bundle exec rspec

ARCHITECTURE.md

@@ -0,0 +1,162 @@
+# git-scm.com architecture
+
+This document describes the general setup and architecture that runs the
+git-scm.com site. The idea is to document all the moving parts that
+_aren't_ checked in to this repository. That may help new people joining
+the project to help out, as well provide some continuity in case the
+maintainer is hit by a bus.
+
+## Content
+
+Though the site is a rails app, it can _mostly_ be thought of as serving
+static content. It's just that we suck in that static content and
+pre-process it using nightly scheduled jobs. We never write anything to
+the database on behalf of user requests.
+
+The content is a mix of:
+
+  - actual static content in this repository
+
+  - community book content brought in from https://github.com/progit;
+    see the `lib/tasks/book2.rake` file.
+
+  - manpages from releases of the git project, imported and formatted
+    via asciidoctor; see the `lib/tasks/index.rake` task.
+
+
+## Heroku
+
+The app itself is served by Heroku. The app name is `git-scm` (so you
+can visit it directly as https://git-scm.herokuapp.com). The site is
+owned by the git-scm.com team. If you want to be involved in managing
+uptime/deploys/etc, you'll need a Heroku account and request to be added
+to that team. The git-scm team receives credits from Heroku so that the
+hosting is free.
+
+We use a few Heroku add-ons:
+
+  - Bonsai elasticsearch (see below)
+
+  - Heroku Postgres as the database
+
+  - Heroku Redis for rails caching
+
+  - Heroku scheduler for cron jobs
+
+The nightly scheduled jobs are:
+
+  - `rake downloads` (pick up newly released git versions)
+
+  - `rake preindex` (pull in and format manpages for released git
+    versions)
+
+  - `rake remote_genbook2` (pull in and format progit2 book content,
+    including translations)
+
+It should be safe to run any of those jobs more frequently. E.g., if you
+know there's a new Git release out, then:
+
+    heroku run rake preindex
+    heroku run rake downloads
+
+will get it on the site without waiting for the nightly run.
+
+Merges to the `master` branch on GitHub auto-deploy to Heroku, so unless
+you're doing something tricky you generally shouldn't need to manually
+deploy.
+
+Note that some of the formatting of manpages and book content happens
+when they are imported by the rake tasks. So after fixing some
+formatting and deploying, the rake jobs may need to be re-run with a
+special flag to re-import (see the individual tasks for details).
+
+
+## Cloudflare
+
+We get enough requests that it's easy to overwhelm the single Heroku
+dyno. So we have Cloudflare sitting in front of it, aggressively caching
+everything. That also should make the site faster to serve to regions
+far away from Heroku's servers.
+
+The Cloudflare setup is mostly pretty simple:
+
+ - they serve DNS for the whole domain (that's where they insert the CDN
+   magic)
+
+ - Cloudflare provides `https://` support to the user. Obviously the
+   site is totally open and doesn't have any sensitive data, so this is
+   really more about integrity. The certificate is generated by
+   Cloudflare (and requires SNI on the browser side).
+
+ - the Cloudflare connection to Heroku is passed over TLS; they provide an
+   "internal" certificate that we ask Heroku to use, so the connection
+   is secured between the two (again, mostly for integrity)
+
+ - the most exotic config is that we use "page rules" to mark the whole
+   site to be cached aggressively, regardless of any caching headers
+   sent from Heroku. This is a bit of a hack, but there's very little on
+   the site that can't be cached (which is perhaps a sign that the rails
+   setup needs to be tweaked to send more reasonable caching headers,
+   but this has been simple and effective so far).
+
+   There are a few special page rules to lift this caching for cases
+   where we do server-side logic (e.g.,
+   https://github.com/git/git-scm.com/issues/1129#issuecomment-363067019"),
+   but the long-term goal is to push that logic onto the client side as
+   much as possible.
+
+Both domains (c.f., the section on [DNS](#DNS) below) are owned by a
+Cloudflare "Team", and membership of that team is required to
+administrate the domains. Similar to the Heroku setup, you can ask to
+join this team if you wish to help out. The information about the team
+setup is in escrow with the Git PLC at Software Freedom Conservancy.
+Cloudflare provides the project with enough credits that it doesn't cost
+anything (though we're not using very many features, so it's possible
+that a free account would be sufficient, too).
+
+## Bonsai Elasticsearch
+
+The search functionality on the site is served by an elasticsearch
+cluster. The index can be populated by running `rake search_index`
+(manpages) and `rake search_index_book` (book) on Heroku (we only index
+the manpages and book). This perhaps should be run nightly, or at least
+after pulling in new content, but it currently isn't done automatically.
+
+The elasticsearch cluster is provided by Bonsai via their Heroku plugin.
+Our needs are larger than their free tier provides, but we receive
+credits from them that provide the service for free.
+
+
+## DNS
+
+The actual DNS service is provided by Cloudflare (see above). The domain
+itself is registered with Gandi, and is owned by the project via
+Software Freedom Conservancy. Funds for the registration are provided
+from the Git project's Conservancy funds, and both the Git PLC and
+Conservancy have credentials to modify the setup.
+
+Note that we own both git-scm.com and git-scm.org; the latter redirects
+to the former.
+
+
+## Manual Intervention
+
+The site mostly just runs without intervention:
+
+  - code merged to `master` is auto-deployed
+
+  - new git versions are detected daily and manpages and download links
+    updated
+
+  - book updates (including translations) are picked up daily
+
+There are a few tasks that still need to be handled by a human:
+
+  - new images added to the book have to be copied manually from
+    progit/progit2
+
+  - new languages for book translations need to be added to
+    `lib/tasks/book2.rake`
+
+  - forced re-imports of content (e.g., a formatting fix to imported
+    manpages) must be triggered manually