You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@jclouds.apache.org by Everett Toews <no...@github.com> on 2014/04/25 18:43:31 UTC
[jclouds-site] Fix This Page links directy to GitHub file (#90)
You can merge this Pull Request by running:
git pull https://github.com/rackerlabs/jclouds-site fix-this-page
Or you can view, comment on it, or merge it online at:
https://github.com/jclouds/jclouds-site/pull/90
-- Commit Summary --
* Fix This Page links directy to GitHub file
-- File Changes --
M _includes/footer.html (2)
-- Patch Links --
https://github.com/jclouds/jclouds-site/pull/90.patch
https://github.com/jclouds/jclouds-site/pull/90.diff
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Everett Toews <no...@github.com>.
Closed #90.
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #281](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/281/) SUCCESS
This pull request looks good
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90#issuecomment-41593918
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Andrew Phillips <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/edit/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
Given your comment, I'm with you on dropping straight into the editor - that seems less potentially confusing than an obfuscated-but-still-there `*`. Is there any way to open the editor with the "Guide to contributing documentation" e.g. in the edit box? Or do we feel there's simply not enough relevant stuff on that page as it is?
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12058351
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by jclouds-commentator <no...@github.com>.
Go to http://fac59c04ec01477aecd7-4ae4656b35ecdd01fcaf7526f2e61f47.r87.cf1.rackcdn.com/ to review your changes.
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90#issuecomment-41414141
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Andrew Phillips <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/edit/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
See https://github.com/jclouds/jclouds-site/pull/92
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12074346
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #280](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/280/) SUCCESS
This pull request looks good
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90#issuecomment-41588023
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Andrew Phillips <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/edit/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
This is +1 for me. As regards linking to the "How to Contribute" doc: isn't there some way to have a default header/text for PRs to a repo? The kind of place where you would say "before you submit this PR, please make sure you've read the commit guidelines" etc.?
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12058907
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Everett Toews <no...@github.com>.
Merged and deployed.
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90#issuecomment-41598197
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by jclouds-commentator <no...@github.com>.
Go to http://6e37743cfeb1760d44b7-d7ac08c43ad88352aa8a6de8aed93d69.r9.cf1.rackcdn.com/ to review your changes.
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90#issuecomment-41594324
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Andrew Phillips <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/edit/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
> Did you refer to this? https://github.com/blog/1184-contributing-guidelines
Yay! That's it! Thanks for finding that, Ignasi!
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12073969
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Andrew Phillips <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/tree/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
I think the link change makes sense, but it's very unclear that the `*` is actually supposed to be a separate link. How about changing that to `how?` or so?
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12026585
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Everett Toews <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/edit/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
I know what you mean. I could have sworn I've seen something like this before too. IIRC you when you go to send a PR to some random repo there's a notice on top that asks you to read the commit guidelines. Unfortunately I couldn't track down any docs on that or find any example repos that already do it.
If we eventually do find it, we should consider enabling that here.
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12059583
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #278](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/278/) SUCCESS
This pull request looks good
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90#issuecomment-41413932
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Ignasi Barrera <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/edit/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
Did you refer to this? https://github.com/blog/1184-contributing-guidelines
It would be a nice addition to all repos!
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12067069
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by jclouds-commentator <no...@github.com>.
Go to http://9b3fa63aa4c9219f9ed0-70edfd29bf3214f9e503322f2057d73a.r54.cf1.rackcdn.com/ to review your changes.
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90#issuecomment-41588311
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Everett Toews <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/tree/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
That it's unclear was kind of the point. I want contributing to the docs to be drop dead simple so you don't even need to necessarily read a how to guide. In fact, it's got me thinking that we could just drop people directly into the GitHub editor. e.g.
https://github.com/jclouds/jclouds-site/edit/master/reference/providers.md
Then they're immediately editing the page. It's obvious what they need to do since they're already in the text editor.
I included the `*` as a way for people to go back and get a description of the process they just went through editing a page. The main action is to Fix This Page and increasing the importance of the description of "how" by increasing the size of the link and making it a work is distracting.
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12057033
Re: [jclouds-site] Fix This Page links directy to GitHub file (#90)
Posted by Everett Toews <no...@github.com>.
> @@ -13,7 +13,7 @@
> </div>
> <div class="col-md-2 column">
> <p class="text-center">
> - <a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">Fix This Page</a>
> + <a href="https://github.com/jclouds/jclouds-site/edit/master/{{ page.path }}">Fix This Page</a><a class="text-primary" href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation"><sup>*</sup></a>
I'll be updating the [How to Contribute Documentation](https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation) guide as soon as this gets merged. I get to do away with the Find section. :)
---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/90/files#r12058518