Update the community website regarding our open source project policy (#358)
* first draft regarding our open source project policy fixing middleman build adding style enhancing fix fix link learning haml enhance faq enhance faq disabling code precise our philosophy docs: fix typos Update 2-not-an-open-source-project.html.md.erb Update index.html.haml Update index.html.haml Update join-form.haml Update 2-not-an-open-source-project.html.md.erb Introducing the first feedback integrate final feedback * first draft regarding our open source project policy fixing middleman build adding style enhancing fix fix link learning haml enhance faq enhance faq disabling code precise our philosophy docs: fix typos Update 2-not-an-open-source-project.html.md.erb Update index.html.haml Update index.html.haml Update join-form.haml Update 2-not-an-open-source-project.html.md.erb Introducing the first feedback integrate final feedback * new draft regarding our policy * fixing style * fix * enhance form * enhance form * fixing title * new deploy * adding missing package
This commit is contained in:
Sylvain Pace
GitHub
parent
dd0712d262
commit
4c9b860cd8
6 changed files with 70 additions and 18 deletions
|
|
@ -37,7 +37,6 @@ window.addEventListener('load', function() {
|
|||
var $email = $(this).find('input[name="email"]');
|
||||
var $url = $(this).find('input[name="url"]');
|
||||
var $owner = $(this).find('input[name="owner"]');
|
||||
var $marketingOptin = $(this).find('input[name="marketing_optin"]');
|
||||
var error = false;
|
||||
$(this).find('.has-errors').removeClass('has-errors');
|
||||
if (!$email.val()) {
|
||||
|
|
|
|||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: Does my project qualify?
|
||||
---
|
||||
|
||||
## Our policy
|
||||
|
||||
We really want to improve documentation with search. Finding the information you are looking for is the very first step when reading docs. Search is key.
|
||||
|
||||
We are always really sorry to have to turn down request, but we are receiving so many applications everyday that we want to give some priority to public technical documentation websites.
|
||||
|
||||
Please note that you can [always run DocSearch on your own infra](https://community.algolia.com/docsearch/documentation/docsearch-scraper/overview/) and [use our free community plan](https://www.algolia.com/pricing). We would be happy to [enhance DocSearch with your feedback](https://github.com/algolia/docsearch).
|
||||
|
||||
## What is required?
|
||||
|
||||
If you want us to host everything for you, there are some few requirements you still need to comply with:
|
||||
- Be **an owner** of the snippet. You will need to inject some JS snippets.
|
||||
- Your website must be **publicly available**. If your website is not, you will need to run our scrapper on a whitelisted server or implemnet your own authentification strategy (not supported so far).
|
||||
- Your website is a **documentation**. We will reduce the scope of our scrap to helpful pages only.
|
||||
- Your website is **production ready**. We will not accept lorem ipsum website.
|
||||
|
||||
## What is considered as a bonus/accelerator
|
||||
|
||||
Since we need to prioritize requests, the following points are big advantages for your project:
|
||||
- You are **Open-Source** or you provide a free plan. We care about the developer community.
|
||||
- You are using a **supported documentation generator**. You can find example below.
|
||||
- Your site is **server-side rendered** (ie no extra JS rendering needed)
|
||||
- You are already **implementing [the generic configuration](#)**
|
||||
|
||||
We are always happy to help product we love. How could you know if you qualify? [Apply!](https://community.algolia.com/docsearch/)
|
||||
|
||||
## My project is already featured
|
||||
|
||||
If your project is already featured or or uses a **supported** documentation-generator tool (e.g. [pkgdown](http://pkgdown.r-lib.org/index.html), [docusaurus](https://docusaurus.io/), [gitbook](https://www.gitbook.com/), [vuepress](https://vuepress.vuejs.org/) .... DocSearch is totally hosted on our side and stays free and will continue this way. We do recommend you to use [the featured Search-UI](https://github.com/algolia/docsearch) or fork it on your own.
|
||||
|
|
@ -28,7 +28,7 @@ layout: default
|
|||
%h2.page-section-title.upper-case.text-demi Why DocSearch?
|
||||
.spacer32
|
||||
%p.color-east-bay.text-regular We're kind of scratching our own itch here. As developers, we spend a lot of time reading documentation, and it isn’t always easy to find the information we need.
|
||||
%p.color-east-bay.text-regular No one's to blame, building a good search for a documentation is a complex challenge.
We just happen to have a lot of experience doing that, and we want to share it with the world.
|
||||
%p.color-east-bay.text-regular No one's to blame, building a good search for a documentation is a complex challenge.
We just happen to have a lot of experience doing that, and we want to share it with the world. Helping open source projects is one way we can contribute to this fantastic philosophy.
|
||||
.spacer40
|
||||
|
||||
#section_examples.page-section.fill-royal-blue
|
||||
|
|
@ -113,10 +113,10 @@ layout: default
|
|||
%h3
|
||||
%span.how-it-works-number.text-lg.color-royal-blue.text-lg.m-r-small 3
|
||||
%span.text-demi
|
||||
You add the search autocomplete to your UI
|
||||
You add the dedicated search autocomplete to your UI
|
||||
.spacer16
|
||||
%p.color-east-bay.text-regular
|
||||
We’ll send you a few lines of code to integrate Algolia autocomplete and power your search.
|
||||
We’ll send you a few lines of code to integrate the dedicated Algolia autocomplete and power your search.
|
||||
%p.color-east-bay.text-regular
|
||||
You will receive the same speed, relevance and best-in-class UX as our paying customers.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,15 +7,18 @@
|
|||
%span.input-group-addon
|
||||
%i.icon.icon-link.color-bunting
|
||||
%input.form-control{type: 'text', placeholder: 'https://website.com/doc', name: 'url'}
|
||||
%p.text-sm.color-east-bay.m-t-small We’ll crawl the <u>documentation pages</u> of your website and index them on Algolia.
|
||||
.spacer32
|
||||
%p.text-sm.color-east-bay.m-t-small
|
||||
We’ll crawl the <u>documentation pages</u> of your website and index them on Algolia.
|
||||
Refer to
|
||||
%a{href: "https://community.algolia.com/docsearch/documentation/docsearch-FAQ/customize-configuration-file/", class:"clickable"} the projects we support
|
||||
.spacer16
|
||||
%label.color-bunting.text-normal{:for => "email"} Email
|
||||
.input-group
|
||||
%span.input-group-addon
|
||||
%i.icon.icon-email.color-bunting
|
||||
%input.form-control{type: 'email', placeholder: 'you@example.org', name: 'email'}
|
||||
%p.text-sm.color-east-bay.m-t-small We’ll email you the code you need to integrate the search into your documentation.
|
||||
.spacer32
|
||||
.spacer16
|
||||
%p.checkbox.text-center
|
||||
%label
|
||||
%input{type: 'checkbox', name: 'owner'}
|
||||
|
|
|
|||
37
package-lock.json
generated
37
package-lock.json
generated
|
|
@ -3246,6 +3246,23 @@
|
|||
"resolved": "https://registry.npmjs.org/abab/-/abab-1.0.4.tgz",
|
||||
"integrity": "sha1-X6rZwsB/YN12dw9xzwJbYqY8/U4=",
|
||||
"dev": true
|
||||
},
|
||||
"tr46": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz",
|
||||
"integrity": "sha1-qLE/1r/SSJUZZ0zN5VujaTtwbQk=",
|
||||
"dev": true
|
||||
},
|
||||
"whatwg-url": {
|
||||
"version": "6.5.0",
|
||||
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-6.5.0.tgz",
|
||||
"integrity": "sha512-rhRZRqx/TLJQWUpQ6bmrt2UV4f0HCQ463yQuONJqC6fO2VoEb1pTYddbe59SkYq87aoM5A3bdhMZiUiVws+fzQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"lodash.sortby": "4.7.0",
|
||||
"tr46": "1.0.1",
|
||||
"webidl-conversions": "4.0.2"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -15131,15 +15148,7 @@
|
|||
"integrity": "sha1-qLE/1r/SSJUZZ0zN5VujaTtwbQk=",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"punycode": "2.1.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"punycode": {
|
||||
"version": "2.1.1",
|
||||
"resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
|
||||
"integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==",
|
||||
"dev": true
|
||||
}
|
||||
"punycode": "1.4.1"
|
||||
}
|
||||
},
|
||||
"traverse": {
|
||||
|
|
@ -17027,7 +17036,15 @@
|
|||
"requires": {
|
||||
"lodash.sortby": "4.7.0",
|
||||
"tr46": "1.0.1",
|
||||
"webidl-conversions": "4.0.2"
|
||||
"webidl-conversions": "3.0.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"webidl-conversions": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
|
||||
"integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE=",
|
||||
"dev": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"which": {
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@
|
|||
"babel-preset-env": "1.7.0",
|
||||
"babel-preset-stage-3": "6.24.1",
|
||||
"conventional-changelog-cli": "2.0.1",
|
||||
"cssnano": "4.0.5",
|
||||
"cssnano": "^4.0.5",
|
||||
"doctoc": "1.3.1",
|
||||
"eslint": "5.2.0",
|
||||
"eslint-config-algolia": "13.1.0",
|
||||
|
|
|
|||
Loading…
Reference in a new issue