Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commita609448

Browse files
committed
Merge pull request#705 from github/add-integrations-directory-list-to-site
Add Integrations Directory guidelines to developer site
2 parents3e530cf +d47d0b3 commita609448

File tree

5 files changed

+220
-0
lines changed

5 files changed

+220
-0
lines changed

‎Rules

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ compile '/feed/' do
2626
filter:kramdown,:toc_levels=>[2]
2727
end
2828

29+
compile'/integrations-directory/*'do
30+
filter:erb
31+
filter:kramdown,:toc_levels=>[2]
32+
filter:tip_filter
33+
filter:colorize_syntax,
34+
:colorizers=>{:javascript=>:rouge}
35+
layoutitem[:layout] ||'integrations-directory'
36+
end
37+
2938
compile'/v3/*'do
3039
filter:search
3140
filter:erb
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title:Getting listed in the Integrations Directory | GitHub API
3+
---
4+
5+
#Getting your integration listed
6+
7+
* TOC
8+
{:toc}
9+
10+
##Listing Requirements
11+
12+
###Provide the right contacts
13+
14+
We want to be sure GitHub can contact your team, if needed. Specifically, we're asking for:
15+
16+
* A technical support contact
17+
* A security contact
18+
* An escalation contact
19+
20+
All three are for GitHub-use only. If there's an urgent that needs your attention, we'll contact your escalation contact and expect a response within one business day. A delayed response from your escalation contact may result in temporary or permanent de-listing of your integration from the directory.
21+
22+
###Provide standard links
23+
24+
We'd like to have a minimum set of links (in the Marketing Guidelines on the right) to include in every integration listing, so that our users have all the information they need. These are:
25+
26+
- Documentation - Please provide a URL with more information on how to use your integration.
27+
- Terms of service - Please provide the Terms of Service URL for users using your integration.
28+
- Privacy Policy - If different than Terms of Service, please include the URL here.
29+
- Support - Please provide a URL or email address for users to contact you directly.
30+
- Status - You should provide us a URL that will be updated when your application is down or experiencing problems. This could be a status site, a blog, a Twitter account, or more. This URL should be publicly accessible.
31+
- Pricing - If you integration costs money or has differed priced tiers of service, please include this URL.
32+
- Installation - Provide the URL for direct installation for users. Note the oAuth requirement below.
33+
34+
###Provide updates to your listing
35+
36+
We want GitHub users to have consistent messaging within the Integrations Directory and your
37+
marketing site. As your product changes, keep your Integration Directory listing up to date. We ask that you refresh the information at least once a year.
38+
39+
###Provide categories for your listing
40+
41+
Help GitHub users find your Integration Directory listing faster with the appropriate categories. Please send us your suggested categories for the listing (multiples are fine). We reserve the right to remove categories from a listing, but we won't add any categories without your approval. Currently, the following categories are available:
42+
43+
* Build
44+
* Collaborate
45+
* Deploy
46+
47+
##Technical Requirements
48+
49+
###Use TLS
50+
51+
Anytime you display GitHub data in your integration, use TLS. If you also use[webhooks](https://developer.github.com/webhooks/) to receive updated data from GitHub, use SSL/TLS there too.
52+
53+
###Delete GitHub data once you lose access to the information
54+
55+
Once you realize you've lost access to a user, organization, repository, and its related objects,
56+
please delete that information in your system within 60 days.
57+
58+
##Choose your type of listing
59+
60+
We offer two types of listings: OAuth installation listings and "learn more" listings.
61+
62+
###OAuth installation listing
63+
64+
{{#tip}}
65+
66+
This is our preferred type of listing wherever possible.
67+
68+
{{/tip}}
69+
70+
The OAuth installation listings are used so customers can immediately install your integration directly
71+
within GitHub's UI. To use this type of listing, provide a URL that will immediately redirect to
72+
GitHub's OAuth authorization flow.
73+
74+
We are happy to help you identify if your integration can already support this. If you'd like a direct installation from the Integrations Directory, your provided installation URL should always forward the user immediately to an OAuth authorization screen. You should never add interstitial pages within that flow.
75+
76+
###"Learn more" listing
77+
78+
The "learn more" listing is used when a user cannot use GitHub OAuth to sign up for an account within
79+
your integration. You will provide a URL that will link a "learn more" button within your
80+
listing to your website. This type of listing is*only used when OAuth is not available before
81+
account creation*.
82+
83+
##Send us your information
84+
85+
In addition to this check, please follow the Marketing Guidelines on the right. The best format for delivery is Markdown (.md) or plain text (.txt). Please attach images at the proper resolution, we aren't able to extract photos from PDFs or Word docs.
86+
Once you're ready just send the materials over emailto[partnerships@github.com](mailto:partnerships@github.com). Thanks! Looking forward to reviewing your listing!
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title:Integrations Directory | GitHub API
3+
layout:integrations-directory
4+
---
5+
6+
#Overview
7+
8+
As one of our integrators, we're excited to tell the world about your GitHub integration at[https://github.com/integrations](https://github.com/integrations). To ensure the GitHub community has the best experience finding and using your integrations, we've outlined a short list of requirements to follow.
9+
10+
We're happy to chat about these if you have any questions, feel free to reach out to[partnerships@github.com](mailto:partnerships@github.com) for additional detail.
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title:Integrations Directory marketing guidelines | GitHub API
3+
---
4+
5+
#Marketing guidelines
6+
7+
* TOC
8+
{:toc}
9+
10+
This document will help you write compelling and well-structured marketing materials to help GitHub users understand the value of your integration. The sections below outline the document structure for integration pages.
11+
12+
##One line blurb
13+
14+
This is a short sentence (70 characters max), that'll show up right below your logo. It can be used for a tagline or quick summary of the integration itself.
15+
16+
##Integration description
17+
18+
Write a single paragraph that describes your integration clearly and speaks directly to the audience (think “you” and “your” over “we” and “our”). Make sure to answer the following questions in your description:
19+
20+
- What does it do?
21+
- How does it integrate with GitHub?
22+
- How does it empower developers?
23+
24+
Keep this section short and sweet.
25+
26+
**Example**
27+
28+
>Sample CI helps you deploy your code with confidence by continuously running your test suite. Avoid bugs and avert deployment disasters by catching bugs before they reach your users. Sample CI can update the build status on your pull requests as they progress and can deploy successful builds to production automatically.
29+
30+
##Images
31+
32+
Images are optional. Well curated images will help people get a sense for how your integration works with GitHub. Use multiple images as an opportunity to tell a story about your integration's workflow.
33+
34+
###Image guidelines
35+
- Images should show your product in action
36+
- When possible, show how your product integrates with GitHub
37+
- Use no more than four images
38+
- Images must be 1290x728 pixels (will appear as 645x364 pixels)
39+
40+
##Features
41+
42+
List some features to give people a better sense of what your integration offers. An ideal number is between three and six—pick the great ones.
43+
44+
###Feature guidelines
45+
- Each feature should have a heading.
46+
- Does the feature have a name? What is it?
47+
- What does the feature do?
48+
- How does it help people build better software?
49+
- Does it interact with any external services? (i.e. can deploy to Heroku, Engine Yard Cloud, etc.)
50+
- Does your feature require any setup?
51+
52+
**Example**
53+
54+
>**Deploy anywhere, with confidence**
55+
56+
>Deploying to production after a successful build is as easy as setting up a bit of configuration, and we’ll deploy your code to Heroku, Engine Yard Cloud, Nodejitsu, cloudControl, OpenShift, CloudFoundry, AppFog, and Amazon OpsWorks.
57+
58+
>Using a custom deployment? Customize the build to deploy to your servers!
59+
60+
##General tips
61+
- Do not use`H1` level headings.
62+
- Use`H3` for section headings,`H4` for subsections.
63+
- Avoid italics. Use bold for emphasis instead.
64+
- Use sentence case for titles.
65+
- Do not write in all caps to provide emphasis.
66+
- Write in[GitHub Flavored markdown](https://help.github.com/articles/github-flavored-markdown/).
67+
68+
##Integration logo guidelines
69+
- Provide your integration logo as a 128x128 pixel PNG.
70+
- Negative space must be transparent.
71+
- Do not stretch or squish your logo to fill the space.
72+
- You'll need to attach this logo to your GitHub Application, before the listing is published.
73+
74+
##Samples
75+
Feel free to look at some of the listings on the current Directory listing, such as[Gitter](https://github.com/integrations/gitter) or[ZenHub](https://github.com/integrations/zenhub).

‎layouts/integrations-directory.html

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<%= render 'head' %>
2+
3+
<bodyclass="api <%= ENV['DEV_MODE'] ? 'dev-mode' : '' %>">
4+
<%= render 'header' %>
5+
6+
<divclass="sub-nav">
7+
<h2><ahref="/integrations-directory">Integrations Directory</a></h2>
8+
9+
<ul>
10+
<li><ahref="/v3/">Reference</a></li>
11+
<li><ahref="/webhooks/">Webhooks</a></li>
12+
<li><ahref="/guides/"class="active">Guides</a></li>
13+
<li><ahref="/libraries/">Libraries</a></li>
14+
</ul>
15+
</div>
16+
17+
<divid="wrapper">
18+
<divclass="content">
19+
<%= yield %>
20+
</div>
21+
22+
<divid="js-sidebar"class="sidebar-shell">
23+
<divclass="sidebar-module">
24+
<ul>
25+
<li><h3><ahref="/integrations-directory/">Overview</a></h3></li>
26+
<li><h3><ahref="/integrations-directory/getting-listed">Getting your integration listed</a></h3></li>
27+
<li><h3><ahref="/integrations-directory/marketing-guidelines">Marketing guidelines</a></h3></li>
28+
</ul>
29+
</div>
30+
31+
<divclass="sidebar-module notice">
32+
<p>This website is a<ahref="https://github.com/github/developer.github.com"target="_blank">public GitHub repository</a>. Please help us by forking the project and adding to it.</p>
33+
</div>
34+
<divclass="sidebar-module api-status"><ahref="https://status.github.com"class="unknown">API Status</a></div>
35+
</div><!-- sidebar-shell -->
36+
</div><!-- #wrapper -->
37+
38+
<%= render 'footer' %>
39+
</body>
40+
</html>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp