Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Consolidate all AMP documentation in docs/ #34047

Merged
merged 1 commit into from
May 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/cherry_pick_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ assignees: ''
MUST: Replace *everything* in angle brackets in the title AND body of this issue.
MUST: Update issue labels to indicate which channels the cherry-pick is going into.

If you have any questions see the [cherry-pick documentation](https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md#Cherry-picks).
If you have any questions see the [cherry-pick documentation](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#Cherry-picks).
-->

# Cherry-pick request
Expand All @@ -25,7 +25,7 @@ TIP: Cherry-picks into Stable most likely require a cherry-pick into Beta / Expe
| :---------------: | :------------: | :------------------: | :----------: | :----------: | ------------------------------------------------------------------------------- |
| #<_ISSUE_NUMBER_> | #<_PR_NUMBER_> | **<YES/NO>** | **<YES/NO>** | **<YES/NO>** | #<_RELEASE_ISSUE_> |

## Why does this issue meet the [cherry-pick criteria](https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md#Cherry-picks)?
## Why does this issue meet the [cherry-pick criteria](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#Cherry-picks)?

<!--
TIP: Be specific.
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/intent-to-implement--i2i-.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Intent-to-implement (I2I)
about: Proposes a significant change/update to AMP. See https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md.
about: Proposes a significant change/update to AMP. See https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md.
title: 'I2I: <your feature/change>'
labels: INTENT TO IMPLEMENT
assignees: ''
Expand All @@ -10,9 +10,9 @@ assignees: ''
<!--
Replace/remove all of the text in brackets, including this text.

See https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md for help determining if you need to file an I2I for your change/fix, instructions on filling out this I2I template and how to get help if you have questions. Note that If you are implementing a minor change/fix, you likely do not need to file this I2I.
See https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md for help determining if you need to file an I2I for your change/fix, instructions on filling out this I2I template and how to get help if you have questions. Note that If you are implementing a minor change/fix, you likely do not need to file this I2I.

If you haven't already done so, sign the Contributor License Agreement (CLA) as soon as possible to avoid delays merging your code. A signed CLA is not necessary to submit this I2I or to send a pull request, but it will be needed before your code can be merged. See https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md#contributor-license-agreement for more information on CLAs.
If you haven't already done so, sign the Contributor License Agreement (CLA) as soon as possible to avoid delays merging your code. A signed CLA is not necessary to submit this I2I or to send a pull request, but it will be needed before your code can be merged. See https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md#contributor-license-agreement for more information on CLAs.
-->

## Summary
Expand Down Expand Up @@ -49,7 +49,7 @@ You should add a link to the launch tracker for this work here if applicable. On
-->

<!--
Add anyone to this cc line that you want to notify about this I2I, including a reviewer once you have found one. See https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md for help in finding a reviewer.
Add anyone to this cc line that you want to notify about this I2I, including a reviewer once you have found one. See https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md for help in finding a reviewer.
-->

/cc @ampproject/wg-approvers
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/intent-to-ship--i2s-.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Intent-to-ship (I2S)
about: Proposes launching a significant change/update to AMP that has already been
implemented. https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md
implemented. https://github.com/ampproject/amphtml/blob/main/docs/contributing.md
title: 'I2S: <your change/update>'
labels: INTENT TO SHIP
assignees: ''
Expand All @@ -12,7 +12,7 @@ assignees: ''
Replace/remove all of the text in brackets, including this text.

Use an Intent-to-ship (I2S) issue to request the launch of a significant change/update to AMP, generally those that required an Intent-to-implement (I2I) issue.
See https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md for more information.
See https://github.com/ampproject/amphtml/blob/main/docs/contributing.md for more information.
-->

## Summary
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/release-tracking-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If you perform cherry picks, add/update the checkboxes above as needed e.g.
- [ ] Release <CHERRY_PICK_RELEASE_NUMBER> promoted to Experimental and Beta channels (<CL submit time>)
-->

See the [release documentation](https://github.com/ampproject/amphtml/blob/main/contributing/release-schedule.md) for more information on the release process, including how to test changes in the Experimental channel.
See the [release documentation](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md) for more information on the release process, including how to test changes in the Experimental channel.

If you find a bug in this build, please file an [issue](https://github.com/ampproject/amphtml/issues/new). If you believe the bug should be fixed in this build, follow the instructions in the [cherry picks documentation](https://go.amp.dev/cherry-picks).

Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
- Mention the GitHub issue that is being addressed by the pull request.
- The keywords `Fixes`, `Closes`, or `Resolves` followed the issue number will automatically close the issue.

> NOTE1: All non-trivial changes (like introducing new features or components) should have an associated issue or reference an I2I (intent-to-implement: go.amp.dev/i2i). Please read through the contribution process (go.amp.dev/contributing/code) for more information.
> NOTE2: To ensure that all PR checks are triggered, make sure you've authenticated with the services listed in the one-time setup instructions at https://github.com/ampproject/amphtml/blob/main/contributing/getting-started-quick.md#one-time-setup (see last step).
> NOTE1: All non-trivial changes (like introducing new features or components) should have an associated issue or reference an I2I (intent-to-implement: go.amp.dev/i2i). Please read through the contribution process (go.amp.dev/docs/code) for more information.
> NOTE2: To ensure that all PR checks are triggered, make sure you've authenticated with the services listed in the one-time setup instructions at https://github.com/ampproject/amphtml/blob/main/docs/getting-started-quick.md#one-time-setup (see last step).

# Example of a good description:

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/create-design-review-issue.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@ const createBody = ({timeUtc, timeUrl, calendarUrl}) =>
Time: [${timeUtc} UTC](${timeUrl}) ([add to Google Calendar](${calendarUrl}))
Location: [Video conference via Google Meet](${vcUrl})

The AMP community holds weekly engineering [design reviews](https://github.com/ampproject/amphtml/blob/main/contributing/design-reviews.md). **We encourage everyone in the community to participate in these design reviews.**
The AMP community holds weekly engineering [design reviews](https://github.com/ampproject/amphtml/blob/main/docs/design-reviews.md). **We encourage everyone in the community to participate in these design reviews.**

If you are interested in bringing your design to design review, read the [design review documentation](https://github.com/ampproject/amphtml/blob/main/contributing/design-reviews.md) and add a link to your design doc or issue by the Monday before your design review.
If you are interested in bringing your design to design review, read the [design review documentation](https://github.com/ampproject/amphtml/blob/main/docs/design-reviews.md) and add a link to your design doc or issue by the Monday before your design review.

When attending a design review please read through the designs _before_ the design review starts. This allows us to spend more time on discussion of the design.

We rotate our design review between times that work better for different parts of the world as described in our [design review documentation](https://github.com/ampproject/amphtml/blob/main/contributing/design-reviews.md), but you are welcome to attend any design review. If you cannot make any of the design reviews but have a design to discuss please let mrjoro@ know on [Slack](https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md#discussion-channels) and we will find a time that works for you.
We rotate our design review between times that work better for different parts of the world as described in our [design review documentation](https://github.com/ampproject/amphtml/blob/main/docs/design-reviews.md), but you are welcome to attend any design review. If you cannot make any of the design reviews but have a design to discuss please let mrjoro@ know on [Slack](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#discussion-channels) and we will find a time that works for you.
`.trim();

function leadingZero(number) {
Expand Down
2 changes: 1 addition & 1 deletion .lando.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This is a configuration file for a Lando-based local dev environment for amphtml.
# It is an alternative to the existing local development environment to what is described in the Getting Started
# End-to-end guide <https://github.com/ampproject/amphtml/blob/main/contributing/getting-started-e2e.md>.
# End-to-end guide <https://github.com/ampproject/amphtml/blob/main/docs/getting-started-e2e.md>.
#
# This environment allows you to encapsulate the amphtml development environment inside of a Docker container.
# Instead of accessing <http://localhost:8000>, this environment can be accessed via <https://amphtml.lando.site>.
Expand Down
8 changes: 4 additions & 4 deletions 3p/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Inclusion of third party software, embeds, and services into AMP

In general all inclusions are subject to [CONTRIBUTING.md](../CONTRIBUTING.md). This files outlines specific rules for certain types of external embed and other software inclusions.
In general all inclusions are subject to [docs/contributing.md](../docs/contributing.md). This files outlines specific rules for certain types of external embed and other software inclusions.

In order to qualify for inclusion, an extended component that integrates a third-party service must generally meet the notability requirements of the English Wikipedia, and is in common use in Internet publishing. As a rough rule of thumb, it should be used or requested by 5% of the top 10,000 websites as noted on builtwith.com, or already integrated into [oEmbed](http://oembed.com/).

Expand All @@ -10,7 +10,7 @@ We highly prefer integrations that do not use iframes. JSONP cannot be used for

Examples: Youtube, Vimeo videos; Tweets, Instagrams; comment systems; polls; quizzes; document viewers

- Our intent is to provide first class support for all embeds that fulfill the notability guidelines laid out in [CONTRIBUTING.md](../CONTRIBUTING.md).
- Our intent is to provide first class support for all embeds that fulfill the notability guidelines laid out in [docs/contributing.md](../docs/contributing.md).
- Consider whether a iframe-with-placeholder solution fits your use case where iframe generation is not done immediately (can be done before user action for instant loading of iframe).
- Consider whether all that is needed is some documentation for how to use the embed with `amp-iframe`.
- Iframes and all sub resources must be served from HTTPS.
Expand Down Expand Up @@ -66,5 +66,5 @@ Review the [ads/README](../ads/README.md) for further details on ad integration.
You should ensure there are integration tests for your extension. These should be added to the AMP
repo where it makes sense. In some cases this won't be possible because it relies on bringing up
third-party infrastructure. In these cases you should maintain testing for the extension on your
infrastructure against both production AMP and [canary](https://github.com/ampproject/amphtml/blob/main/contributing/release-schedule.md#amp-experimental-and-beta-channels).
Upon any monitored failures, an escalation can be raised in [regular AMP communication channel](https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md#discussion-channels).
infrastructure against both production AMP and [canary](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md#amp-experimental-and-beta-channels).
Upon any monitored failures, an escalation can be raised in [regular AMP communication channel](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#discussion-channels).
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,19 @@ AMP is an open source project, and we'd love your help making it better!

- The [amp.dev Support page](https://amp.dev/support/) has resources for getting help.
- Use [Stack Overflow](http://stackoverflow.com/questions/tagged/amp-html) to ask questions about using AMP and find answers to questions others have asked.
- [Let us know about bugs](https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md#report-a-bug), and [file feature requests](https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md#make-a-suggestion) to suggest improvements.
- [Let us know about bugs](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#report-a-bug), and [file feature requests](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#make-a-suggestion) to suggest improvements.
- AMP accepts responsible security disclosures through the [Google Application Security program](https://www.google.com/about/appsecurity/).

## Want to help make AMP better?

- [CONTRIBUTING.md](https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md) has information on how you can help improve AMP, including [ongoing participation](https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md#ongoing-participation) through Slack, weekly design reviews, etc.
- We strongly encourage [code contributions](https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md)!
- **We enthusiastically welcome new contributors to AMP _even if you have no experience being part of an open source project_**. We've made it easy to [get started contributing](https://github.com/ampproject/amphtml/blob/main/CONTRIBUTING.md#get-started-with-open-source).
- [docs/contributing.md](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md) has information on how you can help improve AMP, including [ongoing participation](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#ongoing-participation) through Slack, weekly design reviews, etc.
- We strongly encourage [code contributions](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md)!
- **We enthusiastically welcome new contributors to AMP _even if you have no experience being part of an open source project_**. We've made it easy to [get started contributing](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#get-started-with-open-source).
- Consider joining one of AMP's [Working Groups](https://github.com/ampproject/meta/tree/main/working-groups), where most of the day-to-day work in AMP gets done.

## Other useful information

- [AMP's release documentation](contributing/release-schedule.md) provides details on how and when AMP releases new versions, including [how to know when a change is live in a release](https://github.com/ampproject/amphtml/blob/main/contributing/release-schedule.md#determining-if-your-change-is-in-a-release).
- [AMP's release documentation](docs/release-schedule.md) provides details on how and when AMP releases new versions, including [how to know when a change is live in a release](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md#determining-if-your-change-is-in-a-release).
- [AMP's roadmap](https://amp.dev/community/roadmap) provides details on some of the significant projects we are working on.
- The [AMP meta repository](https://github.com/ampproject/meta) has information _about_ the AMP open source project, including AMP's [governance](https://github.com/ampproject/meta/blob/main/GOVERNANCE.md).
- The [AMP meta repository](https://github.com/ampproject/meta) has information _about_ the AMP open source project, including AMP's [governance](https://github.com/ampproject/meta/blob/main/docs/governance.md).
- [AMP's code of conduct](https://github.com/ampproject/meta/blob/main/CODE_OF_CONDUCT.md) documents how all members, committers and volunteers in the community are required to act. AMP strives for a positive and growing project community that provides a safe environment for everyone.
4 changes: 2 additions & 2 deletions ads/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ If the publisher would like to add custom JavaScript in the `remote.html` file t

## Developer guidelines for a pull request

Please read through [DEVELOPING.md](../contributing/DEVELOPING.md) before contributing to this code repository.
Please read through [developing.md](../docs/developing.md) before contributing to this code repository.

### Files to change

Expand Down Expand Up @@ -380,7 +380,7 @@ To speed up the review process, please run `amp lint` and `amp check-types`, the
- Add **cc ampproject/wg-monetization** in all pull request's descriptions.
- It's highly recommended to maintain [an integration test outside AMP repo](../3p/README.md#adding-proper-integration-tests).
- Please consider implementing the `render-start` and `no-content-available` APIs (see [Available APIs](#available-apis)), which helps AMP to provide user a much better ad loading experience.
- [CLA](../CONTRIBUTING.md#contributing-code): for anyone who has trouble to pass the automatic CLA check in a pull request, try to follow the guidelines provided by the CLA Bot. Common mistakes are:
- [CLA](../docs/contributing.md#contributing-code): for anyone who has trouble to pass the automatic CLA check in a pull request, try to follow the guidelines provided by the CLA Bot. Common mistakes are:
1. Using a different email address in the git commit.
2. Not providing the exact company name in the PR thread.

Expand Down
2 changes: 1 addition & 1 deletion ads/_integration-guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Guidelines for Integrating with AMP

If you are an ad technology provider looking to integrate with AMP HTML, please see the guidelines below.
To ensure minimum latency and quality, please follow the instructions listed [here](../3p/README.md#ads) before submitting a pull request to the AMP open-source project. For general guidance on how to get started with contributing to AMP, please see [CONTRIBUTING.md](../CONTRIBUTING.md).
To ensure minimum latency and quality, please follow the instructions listed [here](../3p/README.md#ads) before submitting a pull request to the AMP open-source project. For general guidance on how to get started with contributing to AMP, please see [docs/contributing.md](../docs/contributing.md).

## Ad Server

Expand Down
2 changes: 1 addition & 1 deletion ads/google/a4a/docs/Network-Impl-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ To create an ad network implementation, you must perform the following:
replaced by their own network. Files must implement all requirements as
specified below. Anything not specified, i.e. helper functions etc are at the
discretion of the ad network, but must be approved using the [process required
for all AMP contributions](https://github.com/ampproject/amphtml/blob/main/contributing/contributing-code.md).
for all AMP contributions](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md).

#### Create the implementation script

Expand Down
2 changes: 1 addition & 1 deletion ads/vendors/ssp.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {setStyle, setStyles} from '../../src/style';

/*
* How to develop:
* https://github.com/ampproject/amphtml/blob/main/contributing/getting-started-e2e.md
* https://github.com/ampproject/amphtml/blob/main/docs/getting-started-e2e.md
*/

/**
Expand Down
Loading