Put the FAQ into www (cpan-api wiki version has been cleaned up)

metacpan · Nov 1, 2013 · 0586ef7 · 0586ef7
1 parent 2f81f56
commit 0586ef7
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 1 deletion.
diff --git a/lib/MetaCPAN/Web/Controller/About.pm b/lib/MetaCPAN/Web/Controller/About.pm
@@ -34,6 +34,11 @@ sub missing_modules : Local {
     $c->stash( template => 'about/missing_modules.html' );
 }
 
+sub faq : Local {
+    my ( $self, $c ) = @_;
+    $c->stash( template => 'about/faq.html' );
+}
+
 
 
 1;
diff --git a/root/about/faq.html b/root/about/faq.html
@@ -0,0 +1,79 @@
+<% PROCESS inc/about-bar.html %>
+<div class="content about-resources">
+<% USE Markdown -%>
+<% FILTER markdown %>
+# FAQ's answered
+
+## Why can't I find a specific module?
+
+See our [missing module](/about/missing_module) page.
+
+## How can I get involved / who is involved?
+
+* [Contact us](/about/contact)
+* [Development information](/about/development)
+* [Who else has contributed?](about/contributors)
+
+## Where can I find the API docs?
+
+The API docs can be found [on the wiki](https://github.com/CPAN-API/cpan-api/wiki/API-docs).
+API requests need to be sent to api.metacpan.org.
+
+## How can I try the API?
+
+[http://explorer.metacpan.org/](http://explorer.metacpan.org/) is an easy way to try sending queries to the back-end.
+
+## Why can't I link my PAUSE account?
+
+***Is your PAUSE email set up?***
+
+If you are a module author you can link your [PAUSE](http://pause.perl.org/)
+account to your MetaCPAN account. But you must configure the email address
+forwarding in your PAUSE account for this to work.
+
+***Do you have multiple accounts?***
+
+If you can only connect your account to github <em>or</em> PAUSE
+(e.g. connecting to one disconnects the other), it is usually because
+you have 2 accounts.
+
+To fix this
+
+ * log in with one of them
+ * go to identities and disconnect that account
+ * log in with the other and connect to the first
+
+## Oops! I made a mistake.  Can you delete my module?
+
+Requests to have modules removed from the CPAN should be directed at the PAUSE admins.  Keep in mind that, if a module contains sensitive information, just deleting it from your CPAN directory is not enough, as it will still reside in the BackPAN.
+
+If the PAUSE admins approve your request, have them CC noc@metacpan.org so that we can push the right buttons to have your work removed from MetaCPAN as well.
+
+## Can I **automatically** redirect links pointing at search.cpan.org to metacpan.org?
+
+For Chrome users, the [MetaCPAN Helper](https://chrome.google.com/webstore/detail/metacpan-helper/aoioenbjpmccpkincghhjfmeceknpcnb) extension will automatically rewrite search.cpan.org links to MetaCPAN.
+
+You can accomplish the same thing by modifying your <code>hosts</code> file. Add the following lines and all links to search.cpan.org (and links to source code) will be redirected to MetaCPAN:
+
+		46.43.35.68 search.cpan.org
+    	46.43.35.68 cpansearch.perl.org
+
+If you do this, be sure to point cpanm to another mirror, as it defaults to search.cpan.org. Here's how:
+
+		export PERL_CPANM_OPT="--mirror http://www.cpan.no/" # Insert your closest mirror here.
+
+## Can I **manually** redirect links pointing at search.cpan.org to metacpan.org?
+
+If you find yourself to be on search.cpan.org and you want to get redirected to corresponding metacpan page, just change the domain name with search.**m**cpan.org. For example:
+
+    	http://search.cpan.org/~xsawyerx/MetaCPAN-API-0.43/lib/MetaCPAN/API.pm
+
+has to be changed to:
+
+    	http://search.mcpan.org/~xsawyerx/MetaCPAN-API-0.43/lib/MetaCPAN/API.pm
+                      ^
+
+<% END %>
+
+</div>
+
diff --git a/root/inc/about-bar.html b/root/inc/about-bar.html
@@ -2,6 +2,8 @@
 <div class="account-bar">
     <a href="/about"<% IF req.action == 'about' %> class="active"<% END %>>About MetaCPAN</a>
     <a href="/about/resources"<% IF req.action == 'about/resources' %> class="active"<% END %>>&nbsp; Contact</a>
+    <a href="/about/faq"<% IF req.action == 'about/faq' %> class="active"<% END %>>&nbsp; FAQ</a>
+
     <a href="/about/sponsors"<% IF req.action == 'about/sponsors' %> class="active"<% END %>>&nbsp; Sponsors</a>
 
     <a href="/about/development"<% IF req.action == 'about/development' %> class="active"<% END %>>Development</a>

diff --git a/root/wrapper.html b/root/wrapper.html
@@ -12,7 +12,7 @@
 },
 {
   title = "FAQ",
-  path = ["https://github.com/CPAN-API/cpan-api/wiki/FAQ"]
+  path = ["/about/faq"]
 },
 {
   title = "Feedback",