Sync with upstream repository

gjtorikian · gjtorikian · commit abbda12b5799 · 2016-01-07T13:52:10.000-08:00
diff --git a/assets/stylesheets/documentation.css b/assets/stylesheets/documentation.css
@@ -214,7 +214,7 @@ a img {
   margin-bottom: 0;
   clear: both;
   height: 61px;
-  background: url(../images/header.png) 0 0 repeat-x;
+  background: url(/assets/images/header.png) 0 0 repeat-x;
 }
 
 #header {
@@ -1382,7 +1382,7 @@ pre span.comment {color: #aaa;}
 @media only screen and (-webkit-min-device-pixel-ratio: 2), only screen and (min-resolution: 192dpi) {
 
   #header-wrapper {
-    background-image: url(../images/header@2x.png);
+    background-image: url(/assets/images/header@2x.png);
     background-size: 8px 61px;
   }
 
diff --git a/content/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions.md b/content/changes/2015-06-24-api-enhancements-for-working-with-organization-permissions.md
@@ -78,7 +78,7 @@ We would love to hear your thoughts on these enhancements. If you have any quest
 [add-team-membership]: /v3/orgs/teams/#add-team-membership
 [list-team-repos]: /v3/orgs/teams/#list-team-repos
 [get-team-repo]: /v3/orgs/teams/#check-if-a-team-manages-a-repository
-[add-team-repo]: /v3/orgs/teams/#add-team-repository
+[add-team-repo]: /v3/orgs/teams/#add-or-update-team-repository
 [org-members-list]: /v3/orgs/members/#members-list
 [org-public-members-list]: /v3/orgs/members/#public-members-list
 [list-collabs]: /v3/repos/collaborators/#list-collaborators
diff --git a/content/search/search-index.json b/content/search/search-index.json
@@ -1,12 +1,15 @@
 [
+  <% if @config[:audience] %>
+    <% @preface = "/enterprise/#{@config[:audience]}" %>
+  <% end %>
   <% @items.select { |item| !item.attributes[:hide_from_search] }.each do |item| %>
   <% next if item[:filename].nil? || !item[:filename].end_with?('.md') %>
   <% @path = item[:filename].split('/')[1..-1].join('/')[0..-4] %>
   <% @path.chomp!('/index') if @path.end_with?('/index') %>
   {
     "title": "<%= clean_for_json(item[:title]) %>",
     <%# Split off the directory name, join, then remove the '.md' extension %>
-    "url": "/<%= @path %>/",
+    "url": "<%= @preface %>/<%= @path %>/",
     "body": "<%= clean_for_json(item.compiled_content) %>"
   },
   <% end %>
diff --git a/content/v3/activity/events/types.md b/content/v3/activity/events/types.md
@@ -496,7 +496,7 @@ Key | Type | Description
 
 ## TeamAddEvent
 
-Triggered when a [repository is added to a team](/v3/orgs/teams/#add-team-repository).
+Triggered when a [repository is added to a team](/v3/orgs/teams/#add-or-update-team-repository).
 
 Events of this type are not visible in timelines. These events are only used to trigger hooks.
 
diff --git a/content/v3/enterprise.md b/content/v3/enterprise.md
@@ -2,7 +2,7 @@
 title: Enterprise
 ---
 
-# Enterprise <%= config[:versions][0] %>
+# Enterprise <%= config[:latest_enterprise_version] %>
 
 {:toc}
 
@@ -35,11 +35,11 @@ Every Enterprise API endpoint is only accessible to GitHub Enterprise site admin
 [User Administration]: /v3/users/administration/
 [Management Console password]: https://help.github.com/enterprise/2.0/admin/articles/accessing-the-management-console/
 
-## Past Releases
+## Releases
 
 The latest release for GitHub Enterprise is <%= config[:versions][0] %>. The GitHub APIs available to this release are located at <https://developer.github.com/enterprise/<%= config[:versions][0] %>/>.
 
-Documentation for the API that's bundled with your GitHub Enterprise appliance is available for past releases:
+Documentation for the API that's bundled with the GitHub Enterprise appliance is available for the following releases:
 
 <% config[:versions][1..-1].each do |version| %>
 * [API documentation for <%= version %>](https://developer.github.com/enterprise/<%= version %>/)
diff --git a/content/v3/oauth_authorizations.md b/content/v3/oauth_authorizations.md
@@ -28,6 +28,7 @@ Make sure you understand how to [work with two-factor authentication](/v3/auth/#
     <li><a href="#update-an-existing-authorization">Update an existing authorization</a></li>
   </ul>
 
+  {% if page.version == 'dotcom' or page.version > 2.2 %}
   <p>
     To reduce the impact of removing the <code>token</code> value,
     the OAuth Authorizations API now includes a new request attribute
@@ -36,7 +37,15 @@ Make sure you understand how to [work with two-factor authentication](/v3/auth/#
     <code>fingerprint</code>), and
     <a href="#get-or-create-an-authorization-for-a-specific-app-and-fingerprint">one new endpoint</a>.
   </p>
-
+  {% else %}
+  <p>
+    To reduce the impact of removing the <code>token</code> value,
+    the OAuth Authorizations API now includes a new request attribute
+    (<code>fingerprint</code>) and three new response attributes
+    (<code>token_last_eight</code>, <code>hashed_token</code>, and
+    <code>fingerprint</code>).
+  </p>
+  {% endif %}
   <p>
     This functionality became the default for all requests on April 20, 2015. Please see <a href="/changes/2015-04-20-authorizations-api-response-changes-are-now-in-effect/">the blog post</a> for full details.
   </p>
diff --git a/content/v3/orgs/hooks.md b/content/v3/orgs/hooks.md
@@ -7,17 +7,21 @@ title: Organization Webhooks
 {:toc}
 
 {% if page.version != 'dotcom' and page.version <= 2.2 %}
+
 {{#tip}}
+
 The Organization Webhooks API is currently available for developers to preview.
 During the preview period, the API may change without advance notice.
-Please see the [blog post](/enterprise/{{ page.version }}/changes/2014-12-03-preview-the-new-organization-webhooks-api/) for full details.
+Please see the [blog post](/changes/2014-12-03-preview-the-new-organization-webhooks-api/) for full details.
 
-To access the API during the preview period, you must provide a custom [media type](/enterprise/2.2/v3/media) in the `Accept` header:
+To access the API during the preview period, you must provide a custom [media type](/enterprise/{{ page.version }}/v3/media) in the `Accept` header:
 
 ```
 application/vnd.github.sersi-preview+json
 ```
+
 {{/tip}}
+
 {% endif %}
 
 Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to actions on GitHub.com. For more information on actions you can subscribe to, check out our [Events documentation][webhook-events].
diff --git a/content/v3/orgs/teams.md b/content/v3/orgs/teams.md
@@ -350,14 +350,14 @@ permissions the team grants on it, by passing the following custom
 <%= headers 200 %>
 <%= json :repo %>
 
-## Add team repository
+## Add or update team repository
 
-In order to add a repository to a team, the authenticated user must have admin
-access to the repository, and must be able to see the team. Also, the repository
-must be owned by the organization, or a direct fork of a repository owned by the
-organization.
+In order to add a repository to a team or update the team's permission on a
+repository, the authenticated user must have admin access to the repository, and
+must be able to see the team. Also, the repository must be owned by the
+organization, or a direct fork of a repository owned by the organization.
 
-    PUT /teams/:id/repos/:org/:repo
+    PUT /teams/:id/repos/:owner/:repo
 
 ### Parameters
 
diff --git a/content/v3/versions.md b/content/v3/versions.md
@@ -143,7 +143,7 @@ The recommendations below will help you prepare your application for the next ma
 
 1. Team attribute: permission
 
-  Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the [Add team repository](/v3/orgs/teams/#add-team-repository) API will use for requests where no `permission` attribute is specified. To change the permission level for every repository on a team, use the [List team repositories](/v3/orgs/teams/#list-team-repos) API to list all of the team's repositories, and then use the [Add team repository](/v3/orgs/teams/#add-team-repository) with a `permission` attribute to update each repository's permission separately.
+  Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the [Add team repository](/v3/orgs/teams/#add-team-repository) API will use for requests where no `permission` attribute is specified. To change the permission level for every repository on a team, use the [List team repositories](/v3/orgs/teams/#list-team-repos) API to list all of the team's repositories, and then use the [Add or update team repository](/v3/orgs/teams/#add-or-update-team-repository) with a `permission` attribute to update each repository's permission separately.
 
 <a id="beta">
 
diff --git a/layouts/head.html b/layouts/head.html
@@ -6,7 +6,9 @@
   <meta http-equiv="imagetoolbar" content="false" />
   <meta name="MSSmartTagsPreventParsing" content="true" />
   <title><%= @item[:title] %> | GitHub Developer Guide</title>
+  <% if @item[:version] == 'dotcom' %>
   <link rel="alternate" type="application/atom+xml" title="API Changes" href="/changes.atom" />
+  <% end %>
   <link href="/assets/stylesheets/application.css" rel="stylesheet" type="text/css" />
   <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
   <script src="/assets/javascripts/application.js" type="text/javascript"></script>
diff --git a/layouts/header.html b/layouts/header.html
@@ -4,6 +4,9 @@
     <div>
       <a class="logo" href="/">GitHub:Developer</a>
       <ul class="nav">
+        <% if @item[:version] != 'dotcom' %>
+        <li>Enterprise <%= config[:latest_enterprise_version] %></li>
+        <% end %>
         <li><a href="/v3/" class="nav-api">API</a></li>
         <li><a href="/program/" class="nav-developers">Developers</a></li>
         <li><a href="/changes/" class="nav-blog">Blog</a></li>
diff --git a/layouts/sidebar.html b/layouts/sidebar.html
@@ -116,7 +116,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/enterprise/">Enterprise <%= config[:versions][0] %></a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/enterprise/">Enterprise <%= config[:latest_enterprise_version] %></a></h3>
         <ul class="js-guides">
           <li><a href="/v3/enterprise/admin_stats/">Admin Stats</a></li>
           <li><a href="/v3/enterprise/ldap/">LDAP</a></li>
diff --git a/nanoc.yaml b/nanoc.yaml
@@ -26,6 +26,11 @@ data_variables:
       path: ""
     values:
       version: "dotcom"
+  -
+    scope:
+      path: "enterprise-(?!backports)"
+    values:
+      version: *latest_enterprise_version
 
 page_variables:
   -
@@ -45,6 +50,12 @@ page_variables:
     # exclude integrations-directory from search
     values:
       hide_from_search: true
+  -
+    scope:
+      path: "enterprise"
+    values:
+      version: *latest_enterprise_version
+      is_enterprise_help: "true"
 
 # For the atom feed.
 base_url: http://developer.github.com
diff --git a/script/enterprise-backport b/script/enterprise-backport
@@ -1,36 +1,126 @@
 #!/usr/bin/env ruby
 
-# Occasionally, a change made to the latest version of the Enterprise API documentation
-# will need to be backported to the previous verison. This script takes the latest content
-# for /enterprise and moves it into the appropriate version folder.
+require 'bundler/setup'
+require 'fileutils'
 
-require 'tmpdir'
+require 'nanoc'
+require 'yaml'
+require 'json'
+require 'active_support/core_ext/hash'
 
-if ARGV.length != 1
-  error = '''Error: Run the script like this: bundle exec script/enterprise-backport [VERSION]
-e.g. bundle exec script/enterprise-backport 2.0
-'''
-  abort error
+Dir.glob('tasks/*.rake').each { |r| load r }
+
+start_message
+
+#################################################################
+##           Phase 1: Build the versioned content              ##
+#################################################################
+
+def build_the_versioned_content
+  config = YAML.load_file('nanoc.yaml')
+
+  # set page.version for every article to <CURR_VERSION>
+  defaults = config['page_variables']
+  defaults.first['values']['version'] = CURR_VERSION
+
+  yaml = """
+is_enterprise_help: true
+audience: #{CURR_VERSION}
+version: #{CURR_VERSION}
+latest_enterprise_version: &latest_enterprise_version #{CURR_VERSION}
+data_variables:
+  -
+    scope:
+      path: ''
+    values:
+      version: #{CURR_VERSION}
+  """
+
+  config_enterprise_admin = Tempfile.new('_config.enterprise.yml')
+  config_enterprise_admin.write(yaml.strip)
+  config_enterprise_admin.rewind
+  config_enterprise_admin.close
+
+  config_enterprise_admin = YAML.load_file(config_enterprise_admin.path)
+
+  versioned_config = symbolize_hash(config.deep_merge(config_enterprise_admin))
+
+  ent_scope_idx = versioned_config[:page_variables].find_index { |v| v[:scope][:path] == 'enterprise' }
+
+  versioned_config[:page_variables][ent_scope_idx][:values][:version] = CURR_VERSION
+
+  Nanoc::Int::SiteLoader.new.new_with_config(versioned_config).compile
+
+  puts `node_modules/gulp/bin/gulp.js assets`
+  fail unless $CHILD_STATUS.to_i == 0
+
+  versioned_config
 end
 
-VERSION = ARGV[0].dup # like, 11.10.340
+#################################################################
+##          Phase 2: Rewrite the generated content             ##
+#################################################################
 
-BRANCH_NAME = "backport-docs-for-#{VERSION}"
+def rewrite_generated_content
+  Dir.glob('output/**/*.html') do |f|
+    doc = Nokogiri::HTML.parse(File.read(f))
+    doc = rewrite_asset_paths(doc)
+    doc = rewrite_anchors(doc)
+    html = doc.to_html.to_s
+    html = rewrite_whitespace(html)
+    File.write(f, html)
+  end
 
-Dir.glob('tasks/*.rake').each { |r| load r }
+  Dir.glob('output/**/*.css') do |css_path|
+    rewrite_octicons_path(css_path)
+  end
 
-setup
+  search_json = File.read('output/search/search-index.json')
+  search_json = rewrite_whitespace(search_json)
+  File.write('output/search/search-index.json', search_json)
+end
+
+#################################################################
+##          Phase 3: Remove non-existent content               ##
+#################################################################
+
+def remove_nonexistent_content
+  # find all the valid files based on the sidebar links
+  v3_api_sidebar = File.open("#{VERSIONED_ENT_PATH}/v3/index.html") { |f| Nokogiri::XML(f) }
+  pages = []
+  v3_api_sidebar.css('#js-sidebar a').each do |a|
+    href = a['href']
+    next if href == '#' || !href.start_with?("/#{VERSIONED_ENT_PATH}/v3")
+    pages << href
+  end
 
-temp_dir = Dir.mktmpdir
-begin
-  `cp -r v3/enterprise enterprise/#{VERSION}/v3/`
+  # remove non-existent files from search index
+  search_json_path = "#{VERSIONED_ENT_PATH}/search/search-index.json"
+  search_json = JSON.parse(File.read(search_json_path))
+  kept_json = []
+  removed_files = []
 
-  rewrite_content("enterprise/#{VERSION}/v3/enterprise")
+  search_json.each do |e|
+    url = e['url']
+    next if url.nil?
+    if pages.include?(url) || url !~ %r{^/#{VERSIONED_ENT_PATH}/v3/}
+      kept_json << e
+    else
+      removed_files << url[1..-1] # trim starting "/"
+    end
+  end
 
-  `git add enterprise`
-  `git commit -m "Added enterprise-#{VERSION} backported files"`
-ensure
-  FileUtils.remove_entry_secure temp_dir
+  File.write(search_json_path, JSON.pretty_generate(kept_json))
+
+  # remove non-existent files from disk
+  removed_files.each { |f| FileUtils.rm_rf(f) }
 end
 
-puts "\n\nOkay! Feel free to `git push #{BRANCH_NAME}` if you like."
+prepare
+build_the_versioned_content
+rewrite_generated_content
+copy_to_destination
+remove_nonexistent_content
+cleanup
+
+puts 'All done!'
diff --git a/script/enterprise-cutter b/script/enterprise-cutter
diff --git a/tasks/enterprise.rake b/tasks/enterprise.rake
diff --git a/tasks/utils.rake b/tasks/utils.rake
diff --git a/tasks/versioning.rake b/tasks/versioning.rake

Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ a img {`
`214`	`214`	`margin-bottom: 0;`
`215`	`215`	`clear: both;`
`216`	`216`	`height: 61px;`
`217`		`- background: url(../images/header.png) 0 0 repeat-x;`
	`217`	`+ background: url(/assets/images/header.png) 0 0 repeat-x;`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`#header {`
`@@ -1382,7 +1382,7 @@ pre span.comment {color: #aaa;}`
`1382`	`1382`	`@media only screen and (-webkit-min-device-pixel-ratio: 2), only screen and (min-resolution: 192dpi) {`
`1383`	`1383`
`1384`	`1384`	`#header-wrapper {`
`1385`		`- background-image: url(../images/header@2x.png);`
	`1385`	`+ background-image: url(/assets/images/[email protected]);`
`1386`	`1386`	`background-size: 8px 61px;`
`1387`	`1387`	`}`
`1388`	`1388`