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.

Sign up for GitHub

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

Jump to bottom

Don't publish internal-only tags on ampproject.org API reference #4965

Closed
taymonbeal opened this issue Sep 13, 2016 · 4 comments
Closed

Don't publish internal-only tags on ampproject.org API reference #4965

taymonbeal opened this issue Sep 13, 2016 · 4 comments
Labels
P1: High Priority Related to: Documentation WG: monetization

Comments

@taymonbeal
Copy link
Member

The amp-a4a, amp-ad-network-adsense-impl, amp-ad-network-doubleclick-impl, and amp-ad-network-fake-impl tags are not part of AMP's publisher-facing API, they're implementation details of the runtime. Including them in the API reference isn't necessary and may mislead publishers.
@lannka
Copy link
Contributor

lannka commented Sep 16, 2016

Are you talking about pages like this one?
If so, I think you can just remove all the md files in those folders, and they should probably disappear.

@cramforce
Copy link
Member

Just mentioned this to @Meggin and @bpaduch today. This is super confusing. CC @pbakaus

@ghost
Copy link

ghost commented Sep 20, 2016

If we remove the .md files from the extension's directory (e.g., amp-ad-network-adsense-impl.md) then we lose possibly valuable info (even if it's implementation details).

Additionally, there are other tags that are "in development" or "experimental" (for example, amp-apester-media, amp-app-banner, amp-share-tracking, etc.). Is there a way that we can include a category within the .md files that the import_docs.js can read and determine what to include/exclude (ie., include docs with availability = "Stable").

@ghost ghost mentioned this issue Sep 20, 2016
Merged
cramforce pushed a commit that referenced this issue Sep 20, 2016
@cramforce
Remove internal only reference docs per issue #4965 (#5124)
dab786b 
* Remove internal only referenc docs per issue #4965

* Appending internal to file name so they aren't pulled into docs
@lannka
Copy link
Contributor

lannka commented Sep 23, 2016

Seems to me the issue is already resolved. Closing it.

@lannka lannka closed this as completed Sep 23, 2016
mityaha pushed a commit to ooyala/amphtml that referenced this issue Nov 30, 2016
@mityaha
Remove internal only reference docs per issue ampproject#4965 (amppro…
72718b2 
…ject#5124)

* Remove internal only referenc docs per issue ampproject#4965

* Appending internal to file name so they aren't pulled into docs
@ghost ghost mentioned this issue Jun 19, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P1: High Priority Related to: Documentation WG: monetization
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@cramforce @taymonbeal @jasti @lannka