Skip to content

Commit fbed405

Browse files
author
Luke Sneeringer
authored
[feat] Linter documentation in GitHub Pages. (#263)
This (incredibly large) PR adds a `docs/` directory that we can serve with GitHub Pages. It provides documentation for three linter rules; the remainder will come in follow-up PRs. Note that as part of this, I intend to enforce (and soon lint for) some consistency on linter rules, including: - One rule per file. - The rule's filename must be derived from the rule name (converting `-` to `_` but no other changes). This is to make things like "View Implmenetation" easy.
1 parent ec6f0ba commit fbed405

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+13661
-49
lines changed

‎.gitignore

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
.idea
2-
.vscode
2+
.vscode
3+
4+
# Jekyll
5+
docs/default.profraw
6+
docs/_site
7+
docs/.jekyll-metadata

‎docs/.dockerignore

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Version control scaffolding
2+
.git
3+
.gitignore
4+
5+
# Docker scaffolding
6+
Dockerfile
7+
.dockerignore
8+
9+
# Ruby & Jekyll scaffolding
10+
_site
11+
12+
# Translations
13+
*.mo
14+
15+
# Mac
16+
.DS_Store
17+
18+
# Mr Developer
19+
.mr.developer.cfg
20+
.project
21+
.pydevproject
22+
23+
# JetBrains
24+
.idea
25+
26+
# Built documentation
27+
docs/_build
28+
docs/_build_doc2dash
29+
30+
# Virtual environment
31+
env/
32+
coverage.xml
33+
34+
# Jekyll metadata
35+
.jekyll-metadata

‎docs/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Jekyll
2+
default.profraw
3+
_site
4+
.jekyll-metadata

‎docs/.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_includes/aip-nav.html
2+
_includes/svgs.html
3+
_sass/colors.scss

‎docs/.prettierrc.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
printWidth: 79
3+
proseWrap: always
4+
singleQuote: true
5+
trailingComma: es5

‎docs/Dockerfile

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
FROM ruby:2.6-alpine
2+
3+
# Copy the existing code into the Docker image.
4+
#
5+
# This will copy everything *at build time* (not at runtime), so it is
6+
# still important to use `--mount` to get a reasonable development loop.
7+
# This makes the image work for both purposes, though.
8+
COPY . /code/
9+
WORKDIR /code/
10+
11+
# Install bundler and gems for this project.
12+
RUN echo "gem: --no-ri --no-rdoc" > ~/.gemrc && \
13+
apk add --no-cache alpine-sdk && \
14+
gem update --system && \
15+
gem install bundler && \
16+
bundle install && \
17+
apk del --no-cache alpine-sdk && \
18+
rm ~/.gemrc
19+
20+
# Install git. (Jekyll expects it.)
21+
RUN apk add --no-cache git
22+
23+
# Set environment variables that GitHub Pages expects.
24+
ENV PAGES_REPO_NWO googleapis/googleapis.github.io
25+
26+
# Expose appropriate ports.
27+
EXPOSE 4000
28+
EXPOSE 35729
29+
30+
# Run Jekyll's dev server.
31+
# Reminder: Use -p with `docker run` to publish ports.
32+
ENTRYPOINT ["bundle", "exec", "jekyll", "serve", \
33+
"--destination", "/site", \
34+
"--host", "0.0.0.0"]

‎docs/Gemfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source "https://rubygems.org" do
2+
gem "jekyll"
3+
gem "github-pages", group: :jekyll_plugins
4+
end

‎docs/Gemfile.lock

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (4.2.10)
5+
i18n (~> 0.7)
6+
minitest (~> 5.1)
7+
thread_safe (~> 0.3, >= 0.3.4)
8+
tzinfo (~> 1.1)
9+
addressable (2.5.2)
10+
public_suffix (>= 2.0.2, < 4.0)
11+
coffee-script (2.4.1)
12+
coffee-script-source
13+
execjs
14+
coffee-script-source (1.11.1)
15+
colorator (1.1.0)
16+
commonmarker (0.17.13)
17+
ruby-enum (~> 0.5)
18+
concurrent-ruby (1.1.5)
19+
dnsruby (1.61.2)
20+
addressable (~> 2.5)
21+
em-websocket (0.5.1)
22+
eventmachine (>= 0.12.9)
23+
http_parser.rb (~> 0.6.0)
24+
ethon (0.12.0)
25+
ffi (>= 1.3.0)
26+
eventmachine (1.2.7)
27+
execjs (2.7.0)
28+
faraday (0.15.4)
29+
multipart-post (>= 1.2, < 3)
30+
ffi (1.10.0)
31+
forwardable-extended (2.6.0)
32+
gemoji (3.0.0)
33+
github-pages (197)
34+
activesupport (= 4.2.10)
35+
github-pages-health-check (= 1.16.1)
36+
jekyll (= 3.7.4)
37+
jekyll-avatar (= 0.6.0)
38+
jekyll-coffeescript (= 1.1.1)
39+
jekyll-commonmark-ghpages (= 0.1.5)
40+
jekyll-default-layout (= 0.1.4)
41+
jekyll-feed (= 0.11.0)
42+
jekyll-gist (= 1.5.0)
43+
jekyll-github-metadata (= 2.12.1)
44+
jekyll-mentions (= 1.4.1)
45+
jekyll-optional-front-matter (= 0.3.0)
46+
jekyll-paginate (= 1.1.0)
47+
jekyll-readme-index (= 0.2.0)
48+
jekyll-redirect-from (= 0.14.0)
49+
jekyll-relative-links (= 0.6.0)
50+
jekyll-remote-theme (= 0.3.1)
51+
jekyll-sass-converter (= 1.5.2)
52+
jekyll-seo-tag (= 2.5.0)
53+
jekyll-sitemap (= 1.2.0)
54+
jekyll-swiss (= 0.4.0)
55+
jekyll-theme-architect (= 0.1.1)
56+
jekyll-theme-cayman (= 0.1.1)
57+
jekyll-theme-dinky (= 0.1.1)
58+
jekyll-theme-hacker (= 0.1.1)
59+
jekyll-theme-leap-day (= 0.1.1)
60+
jekyll-theme-merlot (= 0.1.1)
61+
jekyll-theme-midnight (= 0.1.1)
62+
jekyll-theme-minimal (= 0.1.1)
63+
jekyll-theme-modernist (= 0.1.1)
64+
jekyll-theme-primer (= 0.5.3)
65+
jekyll-theme-slate (= 0.1.1)
66+
jekyll-theme-tactile (= 0.1.1)
67+
jekyll-theme-time-machine (= 0.1.1)
68+
jekyll-titles-from-headings (= 0.5.1)
69+
jemoji (= 0.10.2)
70+
kramdown (= 1.17.0)
71+
liquid (= 4.0.0)
72+
listen (= 3.1.5)
73+
mercenary (~> 0.3)
74+
minima (= 2.5.0)
75+
nokogiri (>= 1.8.5, < 2.0)
76+
rouge (= 2.2.1)
77+
terminal-table (~> 1.4)
78+
github-pages-health-check (1.16.1)
79+
addressable (~> 2.3)
80+
dnsruby (~> 1.60)
81+
octokit (~> 4.0)
82+
public_suffix (~> 3.0)
83+
typhoeus (~> 1.3)
84+
html-pipeline (2.10.0)
85+
activesupport (>= 2)
86+
nokogiri (>= 1.4)
87+
http_parser.rb (0.6.0)
88+
i18n (0.9.5)
89+
concurrent-ruby (~> 1.0)
90+
jekyll (3.7.4)
91+
addressable (~> 2.4)
92+
colorator (~> 1.0)
93+
em-websocket (~> 0.5)
94+
i18n (~> 0.7)
95+
jekyll-sass-converter (~> 1.0)
96+
jekyll-watch (~> 2.0)
97+
kramdown (~> 1.14)
98+
liquid (~> 4.0)
99+
mercenary (~> 0.3.3)
100+
pathutil (~> 0.9)
101+
rouge (>= 1.7, < 4)
102+
safe_yaml (~> 1.0)
103+
jekyll-avatar (0.6.0)
104+
jekyll (~> 3.0)
105+
jekyll-coffeescript (1.1.1)
106+
coffee-script (~> 2.2)
107+
coffee-script-source (~> 1.11.1)
108+
jekyll-commonmark (1.2.0)
109+
commonmarker (~> 0.14)
110+
jekyll (>= 3.0, < 4.0)
111+
jekyll-commonmark-ghpages (0.1.5)
112+
commonmarker (~> 0.17.6)
113+
jekyll-commonmark (~> 1)
114+
rouge (~> 2)
115+
jekyll-default-layout (0.1.4)
116+
jekyll (~> 3.0)
117+
jekyll-feed (0.11.0)
118+
jekyll (~> 3.3)
119+
jekyll-gist (1.5.0)
120+
octokit (~> 4.2)
121+
jekyll-github-metadata (2.12.1)
122+
jekyll (~> 3.4)
123+
octokit (~> 4.0, != 4.4.0)
124+
jekyll-mentions (1.4.1)
125+
html-pipeline (~> 2.3)
126+
jekyll (~> 3.0)
127+
jekyll-optional-front-matter (0.3.0)
128+
jekyll (~> 3.0)
129+
jekyll-paginate (1.1.0)
130+
jekyll-readme-index (0.2.0)
131+
jekyll (~> 3.0)
132+
jekyll-redirect-from (0.14.0)
133+
jekyll (~> 3.3)
134+
jekyll-relative-links (0.6.0)
135+
jekyll (~> 3.3)
136+
jekyll-remote-theme (0.3.1)
137+
jekyll (~> 3.5)
138+
rubyzip (>= 1.2.1, < 3.0)
139+
jekyll-sass-converter (1.5.2)
140+
sass (~> 3.4)
141+
jekyll-seo-tag (2.5.0)
142+
jekyll (~> 3.3)
143+
jekyll-sitemap (1.2.0)
144+
jekyll (~> 3.3)
145+
jekyll-swiss (0.4.0)
146+
jekyll-theme-architect (0.1.1)
147+
jekyll (~> 3.5)
148+
jekyll-seo-tag (~> 2.0)
149+
jekyll-theme-cayman (0.1.1)
150+
jekyll (~> 3.5)
151+
jekyll-seo-tag (~> 2.0)
152+
jekyll-theme-dinky (0.1.1)
153+
jekyll (~> 3.5)
154+
jekyll-seo-tag (~> 2.0)
155+
jekyll-theme-hacker (0.1.1)
156+
jekyll (~> 3.5)
157+
jekyll-seo-tag (~> 2.0)
158+
jekyll-theme-leap-day (0.1.1)
159+
jekyll (~> 3.5)
160+
jekyll-seo-tag (~> 2.0)
161+
jekyll-theme-merlot (0.1.1)
162+
jekyll (~> 3.5)
163+
jekyll-seo-tag (~> 2.0)
164+
jekyll-theme-midnight (0.1.1)
165+
jekyll (~> 3.5)
166+
jekyll-seo-tag (~> 2.0)
167+
jekyll-theme-minimal (0.1.1)
168+
jekyll (~> 3.5)
169+
jekyll-seo-tag (~> 2.0)
170+
jekyll-theme-modernist (0.1.1)
171+
jekyll (~> 3.5)
172+
jekyll-seo-tag (~> 2.0)
173+
jekyll-theme-primer (0.5.3)
174+
jekyll (~> 3.5)
175+
jekyll-github-metadata (~> 2.9)
176+
jekyll-seo-tag (~> 2.0)
177+
jekyll-theme-slate (0.1.1)
178+
jekyll (~> 3.5)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-tactile (0.1.1)
181+
jekyll (~> 3.5)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-time-machine (0.1.1)
184+
jekyll (~> 3.5)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-titles-from-headings (0.5.1)
187+
jekyll (~> 3.3)
188+
jekyll-watch (2.1.2)
189+
listen (~> 3.0)
190+
jemoji (0.10.2)
191+
gemoji (~> 3.0)
192+
html-pipeline (~> 2.2)
193+
jekyll (~> 3.0)
194+
kramdown (1.17.0)
195+
liquid (4.0.0)
196+
listen (3.1.5)
197+
rb-fsevent (~> 0.9, >= 0.9.4)
198+
rb-inotify (~> 0.9, >= 0.9.7)
199+
ruby_dep (~> 1.2)
200+
mercenary (0.3.6)
201+
mini_portile2 (2.4.0)
202+
minima (2.5.0)
203+
jekyll (~> 3.5)
204+
jekyll-feed (~> 0.9)
205+
jekyll-seo-tag (~> 2.1)
206+
minitest (5.11.3)
207+
multipart-post (2.0.0)
208+
nokogiri (1.10.4)
209+
mini_portile2 (~> 2.4.0)
210+
octokit (4.13.0)
211+
sawyer (~> 0.8.0, >= 0.5.3)
212+
pathutil (0.16.2)
213+
forwardable-extended (~> 2.6)
214+
public_suffix (3.0.3)
215+
rb-fsevent (0.10.3)
216+
rb-inotify (0.10.0)
217+
ffi (~> 1.0)
218+
rouge (2.2.1)
219+
ruby-enum (0.7.2)
220+
i18n
221+
ruby_dep (1.5.0)
222+
rubyzip (1.2.2)
223+
safe_yaml (1.0.5)
224+
sass (3.7.3)
225+
sass-listen (~> 4.0.0)
226+
sass-listen (4.0.0)
227+
rb-fsevent (~> 0.9, >= 0.9.4)
228+
rb-inotify (~> 0.9, >= 0.9.7)
229+
sawyer (0.8.1)
230+
addressable (>= 2.3.5, < 2.6)
231+
faraday (~> 0.8, < 1.0)
232+
terminal-table (1.8.0)
233+
unicode-display_width (~> 1.1, >= 1.1.1)
234+
thread_safe (0.3.6)
235+
typhoeus (1.3.1)
236+
ethon (>= 0.9.0)
237+
tzinfo (1.2.5)
238+
thread_safe (~> 0.1)
239+
unicode-display_width (1.5.0)
240+
241+
PLATFORMS
242+
ruby
243+
244+
DEPENDENCIES
245+
github-pages!
246+
jekyll!
247+
248+
BUNDLED WITH
249+
2.0.1

0 commit comments

Comments
 (0)