Skip to content

Commit

Permalink
Setup foundation for amp.dev (ampproject#1307)
Browse files Browse the repository at this point in the history 
* 💄 flex wrap added to filer bubbles list

fliter bubbles should wrap in their flex container for mobile devices

* 💄 padding added to intro text on mobile

* 📱 repsonsive changes added to template overview

* ♻️ refactored stage styling for destination switch

Destination switch inlining was not dynamic enough and the code was messy. Position fixes and a more dynmaic inlining approach has now been achieved

* 📱 padding fix for header-subnav

Padding for subnav was incorrect on desktop/larger devices

* ♻️ small changes made to the language dropdown

* sort guides and tutorials by buckets

* sort guides and tutorials by buckets

* Revert "sort guides and tutorials by buckets"

This reverts commit 4721fbe.

* Revert "sort guides and tutorials by buckets"

This reverts commit 4721fbe.

* 🚧 implemented first parts of stage shortchode

stage shortcode should be broken into a few parts, including the links and possiblity of a button, multiple headlines.

* 💥 commented out stage dropdown temporarily

only temporary while destination switch shortcode gets built

* 🎨 Cleanup component pages structure.

Remove wrong view from all component pages. Add right view to component blueprints.

* 🚚 Rename components scss.

* 🐛 Fix teaser-grid styling in comoponents overview.

* 🐛 Only list docs of the current locale in sidebar.

* 🎨 Consolidate author and translator.

* 🔥 Remove a lot of stale documents.

* 🐛 Delete error causing files.

* 🐛 Fix wrong icon styling.

* 🚚 Take default icon styles out of icon mixin bundle and load it in header.

* ♻️ Remove form for search as it is not yet imlpemented.

* ✨ Bring language selector to live.

* 🚚 Move template overview to the right place.

* 🚧 implemented color option in stage shortcode

Stage shortcode now gives color option for different destintion background colors

* ✨ Allow various types for tip.

* 🍱 Bootstrap community section.

* fill overview pages with content

* fill overview pages with content

* 🎨 Improve condition for wrapping teaser-grid in section.

* 🐛 Fix classname for teaser-grid section wrapper.

* 🎨 Improve the way how teaser columns should be displayed.

If the teaser count is only dividable by 4 than teasers should be displayed in 4 columns. If not always in 3 columns.

* 🐛 Only list docs of the current locale in sidebar.

Apply same fix from commit 1acb4fb to component-sidebar.

* 🔥 Remove unused id from nav-items.

* 🎨 Minor improvring readability.

* 💄 Do not uppercase language names in dropwdown.

* 💄 Decrease padding for tip molecule.

* 🚚 Remove double overview from path for guides view.

* 💄 Write empty notice more clear and remove spaces.

* 🍱 Various content changes and movements.

* 💄 Finetune navigation spaces.

* ♻️ Refactore language-switch.

Cleanup markup; Use lang-code instead of name; Remove anchor tag from current lang;  Fix animation; Finetune design.

* 🎨 Beautify header.scss.

* 👌 Change order of filters.

* 👌 Change color of filters.

* 💄 Increase section width for overview.

* ✨ Add hover animation to all teasers.

* 🐛 Add path because of unknown errors.

* ✨ Sort collections inside sidebar by .

* ✨ created destination-switch shortcode

destination switch shortcode added to seperatly add the destination switch when needed inside the stage shortcode

* ♻️ refactored destination-switch logic

With the new shortcode, the destination-switch logic chagned

* ✨ brought in new destination switch to templates

Template.md files now include the new destination switch shortcode

* 💄 updated style files for destination-stage

updated styling for destination-switch, added grid to home template

* 🔥 remvoed unnecessary dropdown style files

With the new stage and destination switch,  there were old style files that are no longer in use and needed to be removed

* 💄 gradient and font color changes for dest-switch

* 💄 added animation for dest-switch arrow icon

* 👌 Optimize lang-switch animation.

* 🐛 Fix link icon.

* 🚚 Move author section to end of main.

* 🐛 fixed merged conflicts from stage branch merge

* 🚑 Fix path already exists error for shared content.

* 🔥 Remove deprecated version of language dropdown.

* 🔥 Remove styleguide condition from header.

* 🔥 Remove mobile language selector as is deprecated.

* 🎨 Fix indentation in header partial.

* 🎨 Remove unused atoms macro from header template.

* 💄 Group color mixins and make them better readable.

Also add mixins for svg fill attribute.

* 🚚 Use snake_case for destination switch module.

* 🍱 Migrate validate page to new shortcodes.

* 💥 Refactor use of kpi styles.

Add mixin set and set default styles. Remove custom kpi styles in success-story teasers. Do some markup changes.

* 👌 Remove horizontal padding for template-teasers content.

* ♻️ Only use collections in header, remove stale code.

* 🍱 Rearrange content and add needed sections.

* ♻️ Refactor destination switch to be more clear.

* 🐛 Fix various bugs in stage and clean up code.

* 💄 Add info about not-finalness of content.

* 🎨 Correct intendation for destination-switch.

* 🍱 Bootstrap overview section.

* 🎨 Correct blueprint for docs/templates.

* 🐛 Fixing some document references by hand.

* 🔥 Remove unused sidebar shortcode.

* ✨ Add possiblity for document-level subnav.

* 🔇 Remove debug logs from stage.

* 🍱 Bootstrap template section.

* 🍱 Add titles to unnamed collections.

* 🚚 Move environment related configs into specific dir.

* 🔥 Remove empty config in pages package.

* 🚧 Unstash work on importer for finalizing.

* 🐛 rolling animation was broken after refactoring

Rolling animation import inside destination-switch.scss was removed accidently during refactoring, breaking the animation. Import added back in

* 🔥 remvoed get started button from overview

Get started button should not be placed in template-overview.md, this was only for developemnt purposes. Get started button added to home page

* 💄 added styling to stage-button

* 💄 padding changes to stage-button

* ♻️ Adjust content.

* ♻️ Extract stage from main content.

* 🍱 Add new dummy assets.

* ♻️ Add overview-framework templates and styles.

* ♻️ Extract teaser-grid from main content.

* ♻️ Adjust content.

* ♻️ Adjust content and structure.

* ✨ added image to stage-shortcode

Stage can take in an optional image which should be called inside the shortcode. Dummy image added to static and styling added for image

* ♻️ Bring back stage to main content.

* 💄 Minor css adjustments.

* 💥 Hardcode overview templates.

* 💄 style changes to stories-overivew

* 🐛 Use collection.title in component sidebar.

* ♻️ Remove dead and duplicated code in main.j2.

* 🔥 Remove styleguide partials as it is gone.

* 🙈 Do not track imported components reference.

* 💄 updated styles for benefits section

* 🔥 Remove component documents that are going to be imported.

* ✨ Finalize importing of reference.

* ⚡️ Use url.path instead of full URL in sidebar.

* 💄 updated styles for framework-overview tempalte

* 🍱 Add new icon.

* 👌 Update quote styling and markup.

* 🔥 Remove content.

* ✨ Add image to stage.

* ✨ Add bevel atom with shortcode.

* ✨ Add benefit to framework overview websites.

* 💄 styles for overview-emails tempalte

* 💄 updated stores/emails framework templates

* 🍱 Add some more demo examples to build pipeline.

* ➕ Add abe.com package as dependency.

* 🎨 Prepare build script for upcoming build.

* 🚚 Simplify file structure inside lib.

* 💄 updated ads framework overview page

* 🐛 Fixing up some loose ends in lib/pipeline.

* 💄 added kpis to ads framework overview

* 🔀 Clean up after corrupt merge.

* 🚸 Fix up links between overview pages.

* 🔀 Merge some stuff manually from develop.

* 💄 added colors for destination-switch icon

* ✨ added image to framework-overview template

* 💄 Kpi styling for ads framework overview.

* add content to home

* 💄 Adjust bevel styling.

* 💄 Add bevel to ads framework overview.

* 💄 Adjust quote styling.

* 💄 Use fluid kpi for overview.

* update content for home

* 🔥 Comment out indentation of use-case teasers.

* ✨ created template for overview-benefits

* 💄 updated styling for benefits-overview

* ♻️ Refactor link molecule.

* ♻️ Adjust teaser grid.

* 💄 Adjust teaser-grid headline width.

* 📱 responsive for benefits-overview template

* 💄 content and styling for stories-benefits.html

* 💄 content and styling for websites-benefit.html

* 🍱 Add new icon.

* ♻️ Refactore tip-molecule.

* 💄 content and styling added to ads-benefits.html

* 🐛 Fix tip shortcode type bug.

* 💄 styling and content for e-mails benefits.html

* 💄 Update tip markup.

* ✨ created template for overview use-cases

* ♻️ Refactore language switch.

* 🐛 Fix link markup.

* ✏️ use-case typo for the use-case-template.j2

* 🍱 Add dummy assets.

* ✨ created overview/success-stories and styling

* 💄 dummy image added to stage for sucess-stories

* 🐛 Fix stage image dimensions.

* 💄 Polish benefits.

* 🍱 Add dummy assets.

* ✨ creatd overview-functionality template

* 💄 Add images to copy section.

* 💄 Remove gap between header and stage.

* 🚚 Move quote icon to the correct location.

* 🐛 spacing issue solved in docs overview

* 🐛 Fix dest.-switch width and hover animation.

* 🐛 Fix active destination on top.

* 🐛 Fix tag colors.

* 🔥 Remove unused class.

* 💄 fixed ui styling documtentaion tempaltes

* 💄 Polish benefit cards.

* 🐛 Fix dest.-switch width and remove shadow.

* ✨ added new images to static

* 🐛 Fix dest.-switch.

* 🚚 renamed and replaced some images files

* 🐛 fixed file name for teaser-dummy-image

* 🐛 Apply teaser indention only on desktop.

* 💄 Decrease font-size of toc.

* 💄 changes monosapce to inconsolata

* 🐛 Fix logo size.

* 🐛 Fix stories stage.

* 💄 Add space to copy images.

* 🚑 Do not try to write podspec.yaml on GAE.

* ♻️ Refactor reflections of Grow objects.

* ⚡️ Remove all languages from current build.

* 💄 Move link slightly to right.

* 🐛 Syntax fix.

* 🎨 Ensure TOC is in correct position in reference importer.

* 🐛 Give images whitespace.

* ⚡️ Remove empty elements from generated markup.

* ⚡️ Increase delay after generating pages.

* ✨ Add in samples builder.

* 🙈 Only ignore built samples but not the collection.

* 🚚 Rename layout system sample back to original name.

* ✨ Add in all currently available steps into pipeline.

* 💄 home styling

* 💄 Adjust stage color.

* 💄 fixed style issue home

* 🎨 Correctly link all overview pages between each other.

* 🍱 Strip down content only to demo pages.
  • Loading branch information
@matthiasrohmer @pbakaus
matthiasrohmer authored and pbakaus committed Nov 29, 2018
1 parent f65e08e commit d69b05d
Show file tree
Hide file tree
Showing 2,318 changed files with 21,185 additions and 150,564 deletions.
10 changes: 10 additions & 0 deletions .babelrc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"plugins": [
["babel-plugin-root-import"]
],
"presets": [
[
"env"
]
]
}
2 changes: 1 addition & 1 deletion .editorconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ charset = utf-8
trim_trailing_whitespace = true

[*.json]
indent_style = space
indent_style = tab
indent_size = 2
42 changes: 0 additions & 42 deletions .eslintrc.json
View file

This file was deleted.

8 changes: 0 additions & 8 deletions .firebaserc
View file

This file was deleted.

35 changes: 7 additions & 28 deletions .github/ISSUE_TEMPLATE
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,12 @@
<!--
## Objective

Use the template below to report **documentation issues for the www.ampproject.org site**.
(Shortly describe what this issue should achieve)

Have questions about using AMP ?
=================================
- Ask general questions about AMP over on Stack Overflow under the AMP HTML tag: http://stackoverflow.com/questions/tagged/amp-html
- Ask and post questions or problems related to Google Search in Google's AMP forum: https://goo.gl/utQ1KZ
## Background

Think you found a bug in using AMP HTML?
========================================
Please use the bug report template at https://github.com/ampproject/amphtml/issues/new
(Carefully describe why this task should be done)

-->


## Description of the issue found on ampproject.org

Please provide:

- Page link: <insert the URL link to the ampproject.org page(s) that you found the issue on>
- Description of the documentation issue:

## How do we reproduce the issue?

Please provide the steps to reproduce the issue:

1. Step 1 to reproduce
2. Step 2 to reproduce
3. …

What browser are you using?
What O/S are you using?
## Tasks
- [ ] List tasks that need to be
- [ ] completed to finish this task
40 changes: 17 additions & 23 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,27 @@
.idea
.podcache.yaml
.vscode
node_modules
*.pyc
*.log
node_modules

build
assets/css/*
.depcache.json

# Ignore generated files
content/includes/who.yaml

# Ignore imported files
# see scripts/import_docs.json for special cases
content/docs/fundamentals/spec.md
content/docs/fundamentals/spec/*.md
content/docs/contribute/governance.md
content/docs/interaction_dynamic/amp-email-format.md
content/docs/fundamentals/spec/amp-boilerplate.md
content/docs/design/amp-html-layout.md
content/docs/interaction_dynamic/amp-actions-and-events.md
content/docs/troubleshooting/amp-cache-debugging.md
content/docs/fundamentals/amp-cors-requests.md
content/support/developer/get_support.md
content/docs/ads/integration-guide.md
content/docs/ads/amphtml_ads/a4a_spec.md
content/docs/analytics/integrating-analytics.md
content/docs/analytics/amp-managing-user-state.md
# Ignore dynamically built and collected files that are only
# used during development
pages/podspec.yaml
pages/extensions
pages/css
pages/icons
pages/macros
pages/partials
pages/templates
pages/views
pages/content/amp-dev/documentation/examples/*/**
pages/content/amp-dev/documentation/components/*/**

# Ignore imported reference files
content/reference/components/**/*.md
content/reference/components/ads-analytics/amp-share-tracking.md
# Ignore files created during build process
platform/pages
platform/static
43 changes: 0 additions & 43 deletions .travis.yml
View file

This file was deleted.

111 changes: 38 additions & 73 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,106 +1,71 @@
# AMPProject.org [![Build Status](https://travis-ci.org/ampproject/docs.svg?branch=production)](https://travis-ci.org/ampproject/docs)
# amp.dev

You're looking at the source code of the official website of the AMP Project.
Even if you don't plan on contributing, explore how we've built the site for
a good example of how to build a canonical, responsive standalone AMP site.
This repository is meant to work towards the relaunch of the official website
of [ampproject.org](https://www.ampproject.org/) until we reach a progress
that makes a merge over to the original repository beneficial.

## How to build the site

### Install
## Requirements

1. Install the LTS version of [NodeJS](https://nodejs.org). An easy way to do so is with `nvm`. (Mac and Linux: [here](https://github.com/creationix/nvm), Windows: [here](https://github.com/coreybutler/nvm-windows))
```sh
$ nvm install --lts
```

2. Install [Grow](http://grow.io):
1. Install libyaml alongside with [Grow](http://grow.io) as it heavily increases performance while running `grow build`:
```sh
$ curl https://install.growsdk.org | bash
$ brew install libyaml
$ pip install grow
```

3. Install the stable version of [Yarn](https://yarnpkg.com/). (Mac and Linux: [here](https://yarnpkg.com/en/docs/install#alternatives-stable), Windows: [here](https://yarnpkg.com/lang/en/docs/install/#windows-stable))
1. Install the stable version of [Yarn](https://yarnpkg.com/). (Mac and Linux: [here](https://yarnpkg.com/en/docs/install#alternatives-stable), Windows: [here](https://yarnpkg.com/lang/en/docs/install/#windows-stable))
```sh
curl -o- -L https://yarnpkg.com/install.sh | bash
$ curl -o- -L https://yarnpkg.com/install.sh | bash
```

4. Install the dependencies for the project:
1. Install the dependencies for the project:
```sh
$ cd platform
$ yarn
```

### Get a GitHub token or app id/secret

The docs in the reference section of the AMP Project site are not part of this repository; instead they are read from the [amphtml GitHub repository](https://github.com/ampproject/amphtml) "source of truth." When building the site these docs are fetched via GitHub.

Due to GitHub quotas this fetching will quickly fail unless additional information is provided in the request. This can be either a personal access token or an application id/secret.

#### Personal access token

1. Request a GitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Since the docs are fetched from a public repository you only need to select the "public_repo" scope when creating the token. (It's a good practice to limit the token to the scope you need.)
2. In your shell, export the generated personal access token as `AMP_DOC_TOKEN`
#### Application client id and secret
If you prefer not to use a personal access token, you can also create a GitHub application and use its id and secret.
1. Register for a [GitHub application](https://github.com/settings/applications/new).
2. In your shell, export the application client id as `AMP_DOC_ID` and the client secret as `AMP_DOC_SECRET`.
### Build
## Develop
To start developing start a pipeline that takes care of building the frontend, collecting all needed files and start Grow when finished. The pipeline then watches the sources files for changes and rebuilds them if needed.

```sh
$ grow build
$ cd platform
$ yarn run develop
```

This will generate a static, complete build of the site into the **build* folder.
### Develop
Note: Be sure to run `grow build` at least once to pull in reference docs before running the following command.
To run a local test build that does all the minifying and vends the static pages instead of
proxying them through to Grow you can run

```sh
$ grow run
$ cd platform
$ yarn run build:local
$ yarn run start:local
```

You can now open http://localhost:8080/ and continue working on the source files, then reload the page to see changes appear.
## Support
If you've found an error or inconsistency, please [file an issue](
https://github.com/ampproject/docs/issues).

Patches are encouraged. See [Contributing](CONTRIBUTING.md) for details.

## Site details

If you're working with the ampproject.org site, see [AMPProject.org files & build process](contributing/ampproject-files-build-process.md) for details on how the site is built, the purpose of certain files, and other important information.
## License
All image and audio files except in folders "assets/img/partners",
"assets/img/publishers", "assets/img/quotes", and ""assets/img/about" (including *.png, *.jpg, *.svg,
*.mp3, *.wav and *.ogg) are licensed under the CC-BY-NC license. Images in the
excluded folders are not licensed.
All other files are licensed under the [Apache License, Version 2.0](LICENSE).
## Build & Deploy
To build and deploy to the staging environment on [Google App Engine](https://cloud.google.com/appengine/) run the following

```sh
$ cd platform
$ yarn run build:staging
$ yarn run start:staging
```

- - -

Copyright 2015 Google, Inc.
Copyright 2018 The AMP HTML Authors. All Rights Reserved.

Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE file distributed with this work for
additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit d69b05d

Please sign in to comment.