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

Rename extension markdown files to README #1304

Closed
jridgewell opened this issue Jan 5, 2016 · 8 comments
Closed

Rename extension markdown files to README #1304

jridgewell opened this issue Jan 5, 2016 · 8 comments

Comments

@jridgewell
Copy link
Contributor

Eg. amp-access should have its markdown file renamed to README.md. Github displays these files specially, so they do not need to be clicked on when the viewing the extension directory.

@cramforce
Copy link
Member

Good point. This may require some changes on the docs side.
CC @pbakaus @Meggin

@Meggin
Copy link
Contributor

Meggin commented Jan 6, 2016

Good idea. Just need to coordinate with ampproject.org pulls to make sure we still get the reference in the site. I can take a look.

@britice
Copy link

britice commented Jan 26, 2016

I'd like to take this on as a warm-up for future amp-analytics contributions.

@Meggin
Copy link
Contributor

Meggin commented Jan 26, 2016

Brian, when you say take this on, will you be taking on the script that
pulls in the latest reference docs into the /docs github repo, or just
changing in amphtml repo?

It's important we don't break the scripts, so please keep me and Paul
Bakaus in the loop.

On Tue, Jan 26, 2016 at 8:52 AM, Brian Tice [email protected]
wrote:

I'd like to take this on as a warm-up for future amp-analytics
contributions.


Reply to this email directly or view it on GitHub
#1304 (comment)
.

@britice
Copy link

britice commented Jan 26, 2016

Meggin,

..., will you be taking on the script that pulls in the latest reference docs into the /docs github repo, or just changing in amphtml repo?

I'll look into doing both.

It's important we don't break the scripts, so please keep me and Paul Bakaus in the loop.

That make sense. I'll keep you both updated on my progress. If I run into a difficulty which leads me to give up on this and move to an easier starter task, I'll be sure to post something here.

@Meggin
Copy link
Contributor

Meggin commented Jan 26, 2016

Awesome. Thanks!

On Tue, Jan 26, 2016 at 2:50 PM, Brian Tice [email protected]
wrote:

Meggin,

..., will you be taking on the script that pulls in the latest reference
docs into the /docs github repo, or just changing in amphtml repo?

I'll look into doing both.

It's important we don't break the scripts, so please keep me and Paul
Bakaus in the loop.

That make sense. I'll keep you both updated on my progress. If I run into
a difficulty which leads me to give up on this and move to an easier
starter task, I'll be sure to post something here.


Reply to this email directly or view it on GitHub
#1304 (comment)
.

@britice
Copy link

britice commented Jan 26, 2016

My branch for this issue: https://github.com/britice/amphtml/tree/readme-renames

That should cover the changes for this repo but I'll look into what needs to be done in the reference docs scripts before I create a PR.

@britice
Copy link

britice commented Jan 28, 2016

@Meggin @pbakaus, I've added an issue in the docs repo (ampproject/amp.dev#20) concerning the script to pull reference docs.

What's your opinion on the order the changes should be made. In it's current form, the changes I made to the docs script will use either README.md or the current format (e.g. amp-font.md). This would allow for backwards compatibility until all the READMEs are renamed with a PR in this repo.

If backwards compatibility is not a concern, the import script can likely be simplified.

@rudygalfi rudygalfi added this to the M2 milestone Feb 4, 2016
@rudygalfi rudygalfi modified the milestones: M2, Backlog Mar 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants