-
Notifications
You must be signed in to change notification settings - Fork 517
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[feat] Add Jekyll, and layout artifacts.
This commit adds the Jekyll configuration as well as the layout HTML / SASS / JS / etc. to make AIPs look good.
- Loading branch information
Luke Sneeringer
committed
May 6, 2019
1 parent
ea5646d
commit b25841f
Showing
35 changed files
with
13,531 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| source "https://rubygems.org" do | ||
| gem "jekyll" | ||
| gem "github-pages", group: :jekyll_plugins | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,249 @@ | ||
| GEM | ||
| remote: https://rubygems.org/ | ||
| specs: | ||
| activesupport (4.2.10) | ||
| i18n (~> 0.7) | ||
| minitest (~> 5.1) | ||
| thread_safe (~> 0.3, >= 0.3.4) | ||
| tzinfo (~> 1.1) | ||
| addressable (2.5.2) | ||
| public_suffix (>= 2.0.2, < 4.0) | ||
| coffee-script (2.4.1) | ||
| coffee-script-source | ||
| execjs | ||
| coffee-script-source (1.11.1) | ||
| colorator (1.1.0) | ||
| commonmarker (0.17.13) | ||
| ruby-enum (~> 0.5) | ||
| concurrent-ruby (1.1.5) | ||
| dnsruby (1.61.2) | ||
| addressable (~> 2.5) | ||
| em-websocket (0.5.1) | ||
| eventmachine (>= 0.12.9) | ||
| http_parser.rb (~> 0.6.0) | ||
| ethon (0.12.0) | ||
| ffi (>= 1.3.0) | ||
| eventmachine (1.2.7) | ||
| execjs (2.7.0) | ||
| faraday (0.15.4) | ||
| multipart-post (>= 1.2, < 3) | ||
| ffi (1.10.0) | ||
| forwardable-extended (2.6.0) | ||
| gemoji (3.0.0) | ||
| github-pages (197) | ||
| activesupport (= 4.2.10) | ||
| github-pages-health-check (= 1.16.1) | ||
| jekyll (= 3.7.4) | ||
| jekyll-avatar (= 0.6.0) | ||
| jekyll-coffeescript (= 1.1.1) | ||
| jekyll-commonmark-ghpages (= 0.1.5) | ||
| jekyll-default-layout (= 0.1.4) | ||
| jekyll-feed (= 0.11.0) | ||
| jekyll-gist (= 1.5.0) | ||
| jekyll-github-metadata (= 2.12.1) | ||
| jekyll-mentions (= 1.4.1) | ||
| jekyll-optional-front-matter (= 0.3.0) | ||
| jekyll-paginate (= 1.1.0) | ||
| jekyll-readme-index (= 0.2.0) | ||
| jekyll-redirect-from (= 0.14.0) | ||
| jekyll-relative-links (= 0.6.0) | ||
| jekyll-remote-theme (= 0.3.1) | ||
| jekyll-sass-converter (= 1.5.2) | ||
| jekyll-seo-tag (= 2.5.0) | ||
| jekyll-sitemap (= 1.2.0) | ||
| jekyll-swiss (= 0.4.0) | ||
| jekyll-theme-architect (= 0.1.1) | ||
| jekyll-theme-cayman (= 0.1.1) | ||
| jekyll-theme-dinky (= 0.1.1) | ||
| jekyll-theme-hacker (= 0.1.1) | ||
| jekyll-theme-leap-day (= 0.1.1) | ||
| jekyll-theme-merlot (= 0.1.1) | ||
| jekyll-theme-midnight (= 0.1.1) | ||
| jekyll-theme-minimal (= 0.1.1) | ||
| jekyll-theme-modernist (= 0.1.1) | ||
| jekyll-theme-primer (= 0.5.3) | ||
| jekyll-theme-slate (= 0.1.1) | ||
| jekyll-theme-tactile (= 0.1.1) | ||
| jekyll-theme-time-machine (= 0.1.1) | ||
| jekyll-titles-from-headings (= 0.5.1) | ||
| jemoji (= 0.10.2) | ||
| kramdown (= 1.17.0) | ||
| liquid (= 4.0.0) | ||
| listen (= 3.1.5) | ||
| mercenary (~> 0.3) | ||
| minima (= 2.5.0) | ||
| nokogiri (>= 1.8.5, < 2.0) | ||
| rouge (= 2.2.1) | ||
| terminal-table (~> 1.4) | ||
| github-pages-health-check (1.16.1) | ||
| addressable (~> 2.3) | ||
| dnsruby (~> 1.60) | ||
| octokit (~> 4.0) | ||
| public_suffix (~> 3.0) | ||
| typhoeus (~> 1.3) | ||
| html-pipeline (2.10.0) | ||
| activesupport (>= 2) | ||
| nokogiri (>= 1.4) | ||
| http_parser.rb (0.6.0) | ||
| i18n (0.9.5) | ||
| concurrent-ruby (~> 1.0) | ||
| jekyll (3.7.4) | ||
| addressable (~> 2.4) | ||
| colorator (~> 1.0) | ||
| em-websocket (~> 0.5) | ||
| i18n (~> 0.7) | ||
| jekyll-sass-converter (~> 1.0) | ||
| jekyll-watch (~> 2.0) | ||
| kramdown (~> 1.14) | ||
| liquid (~> 4.0) | ||
| mercenary (~> 0.3.3) | ||
| pathutil (~> 0.9) | ||
| rouge (>= 1.7, < 4) | ||
| safe_yaml (~> 1.0) | ||
| jekyll-avatar (0.6.0) | ||
| jekyll (~> 3.0) | ||
| jekyll-coffeescript (1.1.1) | ||
| coffee-script (~> 2.2) | ||
| coffee-script-source (~> 1.11.1) | ||
| jekyll-commonmark (1.2.0) | ||
| commonmarker (~> 0.14) | ||
| jekyll (>= 3.0, < 4.0) | ||
| jekyll-commonmark-ghpages (0.1.5) | ||
| commonmarker (~> 0.17.6) | ||
| jekyll-commonmark (~> 1) | ||
| rouge (~> 2) | ||
| jekyll-default-layout (0.1.4) | ||
| jekyll (~> 3.0) | ||
| jekyll-feed (0.11.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-gist (1.5.0) | ||
| octokit (~> 4.2) | ||
| jekyll-github-metadata (2.12.1) | ||
| jekyll (~> 3.4) | ||
| octokit (~> 4.0, != 4.4.0) | ||
| jekyll-mentions (1.4.1) | ||
| html-pipeline (~> 2.3) | ||
| jekyll (~> 3.0) | ||
| jekyll-optional-front-matter (0.3.0) | ||
| jekyll (~> 3.0) | ||
| jekyll-paginate (1.1.0) | ||
| jekyll-readme-index (0.2.0) | ||
| jekyll (~> 3.0) | ||
| jekyll-redirect-from (0.14.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-relative-links (0.6.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-remote-theme (0.3.1) | ||
| jekyll (~> 3.5) | ||
| rubyzip (>= 1.2.1, < 3.0) | ||
| jekyll-sass-converter (1.5.2) | ||
| sass (~> 3.4) | ||
| jekyll-seo-tag (2.5.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-sitemap (1.2.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-swiss (0.4.0) | ||
| jekyll-theme-architect (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-cayman (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-dinky (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-hacker (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-leap-day (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-merlot (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-midnight (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-minimal (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-modernist (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-primer (0.5.3) | ||
| jekyll (~> 3.5) | ||
| jekyll-github-metadata (~> 2.9) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-slate (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-tactile (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-time-machine (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-titles-from-headings (0.5.1) | ||
| jekyll (~> 3.3) | ||
| jekyll-watch (2.1.2) | ||
| listen (~> 3.0) | ||
| jemoji (0.10.2) | ||
| gemoji (~> 3.0) | ||
| html-pipeline (~> 2.2) | ||
| jekyll (~> 3.0) | ||
| kramdown (1.17.0) | ||
| liquid (4.0.0) | ||
| listen (3.1.5) | ||
| rb-fsevent (~> 0.9, >= 0.9.4) | ||
| rb-inotify (~> 0.9, >= 0.9.7) | ||
| ruby_dep (~> 1.2) | ||
| mercenary (0.3.6) | ||
| mini_portile2 (2.4.0) | ||
| minima (2.5.0) | ||
| jekyll (~> 3.5) | ||
| jekyll-feed (~> 0.9) | ||
| jekyll-seo-tag (~> 2.1) | ||
| minitest (5.11.3) | ||
| multipart-post (2.0.0) | ||
| nokogiri (1.10.1) | ||
| mini_portile2 (~> 2.4.0) | ||
| octokit (4.13.0) | ||
| sawyer (~> 0.8.0, >= 0.5.3) | ||
| pathutil (0.16.2) | ||
| forwardable-extended (~> 2.6) | ||
| public_suffix (3.0.3) | ||
| rb-fsevent (0.10.3) | ||
| rb-inotify (0.10.0) | ||
| ffi (~> 1.0) | ||
| rouge (2.2.1) | ||
| ruby-enum (0.7.2) | ||
| i18n | ||
| ruby_dep (1.5.0) | ||
| rubyzip (1.2.2) | ||
| safe_yaml (1.0.5) | ||
| sass (3.7.3) | ||
| sass-listen (~> 4.0.0) | ||
| sass-listen (4.0.0) | ||
| rb-fsevent (~> 0.9, >= 0.9.4) | ||
| rb-inotify (~> 0.9, >= 0.9.7) | ||
| sawyer (0.8.1) | ||
| addressable (>= 2.3.5, < 2.6) | ||
| faraday (~> 0.8, < 1.0) | ||
| terminal-table (1.8.0) | ||
| unicode-display_width (~> 1.1, >= 1.1.1) | ||
| thread_safe (0.3.6) | ||
| typhoeus (1.3.1) | ||
| ethon (>= 0.9.0) | ||
| tzinfo (1.2.5) | ||
| thread_safe (~> 0.1) | ||
| unicode-display_width (1.5.0) | ||
|
|
||
| PLATFORMS | ||
| ruby | ||
|
|
||
| DEPENDENCIES | ||
| github-pages! | ||
| jekyll! | ||
|
|
||
| BUNDLED WITH | ||
| 2.0.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # API Improvement Proposals | ||
|
|
||
| ## What are AIPs? | ||
|
|
||
| AIP stands for **API Improvement Proposal**, which is a design document | ||
| providing high-level, concise documentation for API development. They are to | ||
| serve as the source of truth for API-related documentation at Google and the | ||
| means by which API teams discuss and come to consensus on API guidance. | ||
|
|
||
| ## Reading AIPs | ||
|
|
||
| The easiest way to read AIPs is using GitHub Pages: [aip.dev](https://aip.dev). | ||
| If you prefer, you can also read the source files, which are in this repository | ||
| in the [`aip/`](https://github.com/googleapis/aip/tree/master/aip) directory. | ||
|
|
||
| ## Proposing / Contributing | ||
|
|
||
| We would be happy to consider proposals. In order to propose a new AIP, start | ||
| by [opening an issue](https://github.com/googleapis/aip/issues). If there is | ||
| general interest and it comes time to draft an actual proposal, consult our | ||
| [contributing guide](./CONTRIBUTING.md). | ||
|
|
||
| ## License | ||
|
|
||
| Except as otherwise noted, the content of this repository is licensed under the | ||
| [Creative Commons Attribution 4.0 License][1], and code samples are licensed | ||
| under the [Apache 2.0 License][2]. | ||
|
|
||
| For the full text of each license, see [`LICENSE.md`](./LICENSE.md). For | ||
| additional details, see the developer.google.com [Site Policies][3]. | ||
|
|
||
| [1]: https://creativecommons.org/licenses/by/4.0/ | ||
| [2]: https://www.apache.org/licenses/LICENSE-2.0 | ||
| [3]: https://developers.google.com/terms/site-policies |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| markdown: kramdown | ||
| plugins: | ||
| - jekyll-redirect-from | ||
| url: https://github.com/googleapis/aip | ||
| defaults: | ||
| - scope: | ||
| path: aip | ||
| values: | ||
| js: | ||
| - /assets/js/proto-syntax.js | ||
| - scope: | ||
| path: README.md | ||
| values: | ||
| exclude_from_search: true | ||
| tipue_search: | ||
| include: | ||
| pages: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <nav class="h-c-breadcrumbs h-u-mt-std" aria-label="You are here."> | ||
| <ol class="h-c-breadcrumbs__list"> | ||
| <li class="h-c-breadcrumbs__item" aria-level="1"> | ||
| <a class="h-c-breadcrumbs__link" href="/">API Improvement Proposals</a> | ||
| </li> | ||
| {% if page.aip %} | ||
| <li class="h-c-breadcrumbs__item" aria-level="2"> | ||
| <a | ||
| class="h-c-breadcrumbs__link" | ||
| href="/{{ page.aip.scope | default: '#aip-listing' }}" | ||
| > | ||
| {{ page.aip.scope | default: 'general' | capitalize }} AIPs | ||
| </a> | ||
| </li> | ||
| {% endif %} | ||
| <li | ||
| class="h-c-breadcrumbs__item h-c-breadcrumbs__item--active" | ||
| aria-level="3" | ||
| > | ||
| {{ page.title }} | ||
| </li> | ||
| </ol> | ||
| </nav> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| {% assign areas = 'apps,cloud' | split: ',' %} | ||
| {% assign scope = page.aip.scope or page.aip_index.scope %} | ||
| <nav id="aip-nav" class="docs-component-nav"> | ||
| <ul class="nav-list"> | ||
| <li class="nav-item nav-item-header">API Improvement Proposals</li> | ||
| <li class="nav-item{% if page.url == '/' %} nav-item-active{% endif %}"> | ||
| <a href="/">General</a> | ||
| </li> | ||
| {% for area in areas %} | ||
| {% if page.aip_index.scope == area %} | ||
| {% assign scope = area %} | ||
| {% endif %} | ||
| <li class="nav-item{% if page.aip_index.scope == area %} nav-item-active{% endif %}"> | ||
| <a href="/{{ area }}">{{ area | capitalize }}</a> | ||
| </li> | ||
| {% endfor %} | ||
| <li class="nav-item nav-item-header">Tools</li> | ||
| <li class="nav-item"> | ||
| <a href="https://github.com/googleapis/api-linter" target="_blank">API Linter</a> | ||
| <svg role="img" class="h-c-icon h-c-icon--arrow-external" style="width: 14px; height: 14px; margin-bottom: -2px;"> | ||
| <use xlink:href="#mi-arrow-forward"></use> | ||
| </svg> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a href="https://cloud.google.com/apis/design/" target="_blank">Cloud API Design Guide</a> | ||
| <svg role="img" class="h-c-icon h-c-icon--arrow-external" style="width: 14px; height: 14px; margin-bottom: -2px;"> | ||
| <use xlink:href="#mi-arrow-forward"></use> | ||
| </svg> | ||
| </li> | ||
| <li class="nav-item nav-item-header"> | ||
| {{ scope | default: 'general' | capitalize }} AIPs | ||
| </li> | ||
| {% for p in site.pages %}{% if p.aip and p.aip.scope == scope -%} | ||
| <li class="nav-item{% if p.url == page.url %} nav-item-active{% endif %}"> | ||
| <a href="{{ p.url }}"> | ||
| <span class="aip-number">{{ p.aip.id }}</span> {{ p.title }} | ||
| </a> | ||
| </li> | ||
| {% endif %}{% endfor -%} | ||
| </ul> | ||
| </nav> |
Oops, something went wrong.