nikon/docsearch
1
0
Fork 0
Code Activity Actions
docsearch/docs/src/who-can-apply.md
Sylvain Pace a94f4c57dc
Doc/update content (#434) 
* # This is a combination of 2 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

chore(deps): update dependency onchange to v4.1.0

integrate previous work

enhance tyle/content

reformat part 1

wait for review

adance start_urls

enhance attributes description

fix typo

proofread documentation/docsearch

add apiKey mention

intefrate review and small fixes

finished proofreading

update sclient-rendering

use unseen review

# This is the commit message #2:

update README #269

# This is the commit message #3:

fix json

# This is the commit message #2:

enhance  as algolia/docsearch-configs#387

# This is the commit message #3:

updating flavicon

# This is the commit message #2:

Update 1-customize-configuration-file.html.md.erb

* # This is a combination of 2 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

chore(deps): update dependency onchange to v4.1.0

integrate previous work

enhance tyle/content

reformat part 1

wait for review

adance start_urls

enhance attributes description

fix typo

proofread documentation/docsearch

add apiKey mention

intefrate review and small fixes

finished proofreading

update sclient-rendering

use unseen review

# This is the commit message #2:

update README #269

# This is the commit message #3:

fix json

# This is the commit message #2:

enhance  as algolia/docsearch-configs#387

# This is the commit message #3:

updating flavicon

# This is the commit message #2:

Update 1-customize-configuration-file.html.md.erb

* documenting algolia/docsearch-scraper#387

* documenting algolia/docsearch-scraper#387

* fixing changelog

* fixing typo

* # This is a combination of 2 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

chore(deps): update dependency onchange to v4.1.0

integrate previous work

enhance tyle/content

reformat part 1

wait for review

adance start_urls

enhance attributes description

fix typo

proofread documentation/docsearch

add apiKey mention

intefrate review and small fixes

finished proofreading

update sclient-rendering

use unseen review

# This is the commit message #2:

update README #269

# This is the commit message #3:

fix json

# This is the commit message #2:

enhance  as algolia/docsearch-configs#387

# This is the commit message #3:

updating flavicon

# This is the commit message #2:

Update 1-customize-configuration-file.html.md.erb

* # This is a combination of 2 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

# This is a combination of 3 commits.
# This is the 1st commit message:

chore(deps): update dependency onchange to v4.1.0

integrate previous work

enhance tyle/content

reformat part 1

wait for review

adance start_urls

enhance attributes description

fix typo

proofread documentation/docsearch

add apiKey mention

intefrate review and small fixes

finished proofreading

update sclient-rendering

use unseen review

# This is the commit message #2:

update README #269

# This is the commit message #3:

fix json

# This is the commit message #2:

enhance  as algolia/docsearch-configs#387

# This is the commit message #3:

updating flavicon

# This is the commit message #2:

Update 1-customize-configuration-file.html.md.erb

* documenting algolia/docsearch-scraper#387

* documenting algolia/docsearch-scraper#387

* fixing typo

* fixing style issue

* fixing recurrnet issue

* general github handle

* fixing missed conflict

* fix and closes algolia/docsearch-configs-private#82

* remove builded content

* adding hitsperpage

* fix

* enhance

* doc proof reading part 1

* adding how to build an index and updating content

* reformat

* textlint

* typos

* Update behavior.md

* Update config-file.md

* Update crawler-overview.md

* Update dropdown.md

* Update faq.md

* Update how-do-we-build-an-index.md

* Update how-does-it-work.md

* Update inside-the-engine.md

* Update integrations.md

* Update styling.md

* Update tips.md

* Update who-can-apply.md

* Update integrations.md

* Usefull but sometime we do want to ignore it on purpose

* 4fca279b9a

* auto fix & formating
2018-09-04 08:47:38 +02:00

2.3 KiB
Raw Blame History

layout title
two-columns Who can apply?

DocSearch was built from the ground up with the idea of improving search on large technical documentation. For that reason, we are offering a free hosting version to all online technical documentation.

We're always sad to have to turn down applications, but with the number of requests we receive everyday, we've had to focus on several criteria. We hope you understand.

The checklist

To have your request validated, we'll ask that you validate all the following points.

  • You must be the owner of the website, or at least have the power to update its content. You'll have to include a JavaScript snippet to enable DocSearch.

  • Your website must be publicly available. We do not host index for websites that are available behind an authentication or a private network.

  • Your website must be a documentation website. We do not index blogs or commercial content.

  • Your website must have some final content. We won't index empty websites nor those filled with lorem ipsum placeholder content. Please, wait until you have written some documentation before applying. We would be happy to help you as soon as you have a steady design.

If in doubt, don't hesitate to apply and we'll figure it out together.

Even if we cannot accept your request, this does not mean that you cannot enjoy great search on your website. DocSearch is entirely open source and you can run it yourself, or use any of our other API clients to take advantage of Algolia's features.

Priority

We're receiving dozens of requests every day, and while we strive to answer them all as fast as we can, we sometimes give priority to some based on the following criteria:

  • 🙂 If your project is open source, we'll handle it before any other closed-source product. We love open source and want to help as much as we can.

  • 🙂 If you're using one of our official integrations, creating your config will be much faster for us.

  • ☹️ If your website is rendered in the browser through JavaScript, it means that we'll have to crawl it through a much slower browser emulation. We highly recommend that you put in place server-side rendering for the useful textual content.