|
1 | | -# Web Fundamentals <master> [](https://ci.cloudware.io/google/WebFundamentals) |
| 1 | +# Web Fundamentals has **MOVED** |
2 | 2 |
|
3 | | -`master` staging: https://web-central.appspot.com/web/ |
4 | | -<hr> |
| 3 | +We are currently working in the [**next-version**](https://github.com/google/WebFundamentals/tree/next-version) branch! Please submit any new PRs there. |
5 | 4 |
|
6 | | -Web Fundamentals is a technical documentation center for multi-device web |
7 | | -development. Our goal is to build a resource for modern web developers |
8 | | -that’s as curated and thorough as developer.android.com or iOS Dev Center. |
9 | | - |
10 | | -# Installing Dependencies |
11 | | - |
12 | | -To build and run this project you need to have Ruby, Node and NPM. |
13 | | - |
14 | | -## Mac |
15 | | - |
16 | | -1. Install [XCode Command Line Tools](https://developer.apple.com/xcode/downloads/) |
17 | | -1. Install node |
18 | | - * [https://nodejs.org/en/](https://nodejs.org/en/) |
19 | | -1. Install [RVM](https://rvm.io/rubies/default) |
20 | | - * `curl -sSL https://get.rvm.io | bash` |
21 | | -1. Set RVM Default to 2.2.0 |
22 | | - * `rvm install ruby-2.2.0` |
23 | | - * `rvm --default use 2.2.0` |
24 | | -1. Install [Pygments](http://pygments.org/) |
25 | | - * `easy_install pygments` |
26 | | -1. Install bundler |
27 | | - * `gem install bundler` |
28 | | -1. Install [RubyGems](https://rubygems.org/) dependencies ([Jekyll](http://jekyllrb.com/) and [Kramdown](http://kramdown.gettalong.org/)) |
29 | | - * `rvm . do bundle install` |
30 | | -1. Install the [Gulp CLI](http://gulpjs.com/) |
31 | | - * `npm install -g gulp` |
32 | | -1. Install [npm](https://www.npmjs.org) dependencies |
33 | | - * `npm install` |
34 | | -1. Get the [App Engine SDK for Python](https://cloud.google.com/appengine/downloads#Google_App_Engine_SDK_for_Python) and unzip into the google_appengine folder inside the project root. Add it to your path accordingly (in bash, `$ PATH=./google_appengine:$PATH`) |
35 | | - |
36 | | -# Running the site |
37 | | - |
38 | | -To run the site: |
39 | | - |
40 | | - gulp |
41 | | - |
42 | | -This will compile styles & javascript and build the site with Jekyll. If thats |
43 | | -all working, it will start a server on port 7331 (which you can reach at |
44 | | -[http://localhost:7331/web/fundamentals](http://localhost:7331/web/fundamentals)). |
45 | | - |
46 | | - |
47 | | -Any changes to files will result in the appropriate tasks be running in gulp. |
48 | | - |
49 | | -## Faster Jekyll Builds |
50 | | - |
51 | | -To make the build faster you can define a language and/or section of the site |
52 | | -be built. |
53 | | - |
54 | | -If you want to build a single language then run this: |
55 | | - |
56 | | - gulp --lang en |
57 | | - |
58 | | -If you want to build a specific section then run this: |
59 | | - |
60 | | - gulp --section shows |
61 | | - |
62 | | -These can be combined like so: |
63 | | - |
64 | | - gulp --lang en --section shows |
65 | | - |
66 | | -## Learning More About Jekyll and Liquid Used |
67 | | - |
68 | | -We have a resource area which you can access at [https://web-central.appspot.com/web/resources/?hl=en](https://web-central.appspot.com/web/resources/?hl=en) that should get you up and running with a lot of the custom and useful info. |
69 | | - |
70 | | -# View staged pull requests and branches |
71 | | - |
72 | | -**Note: this feature is experimental.** |
73 | | - |
74 | | -The build process automatically creates staging sites for all pull requests. |
75 | | - |
76 | | -To access the staging site for a pull request: |
77 | | - |
78 | | -1. Open the pull request on `github.com`. |
79 | | -2. Click **Show All Checks**. |
80 | | -3. Click **Details** next to the **Builder** check. The staging site opens |
81 | | - up in a new tab. |
82 | | - |
83 | | -You can also access each staging site directly, using the following URL: |
84 | | - |
85 | | - https://pr-<NUMBER>-dot-weasel-dot-web-central.appspot.com |
86 | | - |
87 | | -Where `<NUMBER>` is the pull request number. For example, the URL for |
88 | | -PR #1000 would be: |
89 | | - |
90 | | - https://pr-1000-dot-weasel-dot-web-central.appspot.com |
91 | | - |
92 | | -Staged branches are also available at: |
93 | | - |
94 | | - <branch>-dot-weasel-dot-web-central.appspot.com |
95 | | - |
96 | | -Where `<branch>` is the name of the branch. |
97 | | - |
98 | | -**The URL pattern for pull requests and branches may change without notice.** |
99 | | - |
100 | | -# Translations |
101 | | - |
102 | | -See [our translations guide](https://developers.google.com/web/resources/translations/) |
103 | | - |
104 | | -# Building Shows |
105 | | - |
106 | | -You need the python [Google API client](https://developers.google.com/api-client-library/python/start/installation) |
107 | | - |
108 | | -For Linux: |
109 | | - |
110 | | - pip install --upgrade google-api-python-client |
111 | | - |
112 | | -# Content plan |
113 | | - |
114 | | -Content plan for Web Fundamentals is tracked through GitHub Issues and our [Site Structure + Content Inventory](http://goo.gl/nWDD0M) doc |
115 | | - |
116 | | -# Release status |
117 | | - |
118 | | -The project was soft launched in late April with a formal v1 launch in June 2014. We've now moved to a six-week rolling release cycle. |
119 | | - |
120 | | -# Project Structure |
121 | | - |
122 | | -This is a Jekyll build. |
123 | | - |
124 | | -``` |
125 | | -/appengine-config - The server to host the static content |
126 | | -/gulp-tasks - The tasks available to Gulp split by responsibility (styles, scripts etc.) |
127 | | -/src - The documentation |
128 | | - /content - The content in each language |
129 | | - /en - The base language folder. Sub folders are sections of the site |
130 | | - /fundamentals |
131 | | - /showcase |
132 | | - /shows |
133 | | - ...etc... |
134 | | - /<langcode> - Overrides for that language, following the en structure. |
135 | | - /jekyll - |
136 | | - /_config - These are files which define specific settings for the setup of the page |
137 | | - /_data - These are static strings and their translations |
138 | | - /_includes - These a snippets of HTML you can include in a page |
139 | | - /_layouts - There are layouts you can reference in the YAML of your doc |
140 | | - /_plugins - This is the guts of Web Fundamentals. |
141 | | - /static |
142 | | - /imgs - Images used in Web Fundamentals |
143 | | - /scripts - Javascript - not used in final deployment of WF only local |
144 | | - /styles - Sass for web fundamentals |
145 | | - /third_party |
146 | | - /tests |
147 | | - /tools |
148 | | -``` |
149 | | - |
150 | | -The site is generated in `/build`, which is never checked in. |
151 | | - |
152 | | -# Contributing |
153 | | - |
154 | | -Web Fundamentals is an open source project and we welcome your contributions! |
155 | | -Before submitting a pull request, please review [CONTRIBUTING.md](CONTRIBUTING.md) |
156 | | -and make sure that there is an issue filed describing the fix or new content. |
157 | | -If you don't complete these steps, we won't be able to accept your pull request, sorry. |
| 5 | +The setup is a little bit different, but hopefully significantly easier for you. |
0 commit comments