1
0
Fork 0
Commit graph

30 commits

Author SHA1 Message Date
Sylvain Pace
b80a43f4de
doc(content) Updating configuration sectiion (#642)
* using feedback from algolia/docsearch-configs#795

* fixing code-block-style

* Resolved comments

* Proofread

* auto-lint after review
2019-04-02 13:32:20 +02:00
Sylvain Pace
25f7214830
Docs/update (#641)
* fixing typo

* keeping same convention

* avoid wrong use of word crawling

* removing superfluous comment

* make the documentation more explicit to prevent error in the key usage, introduces feedback from algolia/docsearch-scraper#438, give instruction about how to use the headless chrome

* add synonym, resolves #640

* precise sitemap

* fix typos

* removing unavailable anchor

* fixing wrong URL

* resolves #518 by removing unwanted char from anchors

* fixing linter issues

* fix remark-lint warning
2019-03-28 14:32:31 +01:00
Dan Allen
98b7a7f826 document the UPDATE_NB_HITS configuration variable (#583) 2019-03-22 15:11:59 +01:00
s-pace
c3fd6c04be move global recommendation 2019-03-12 10:01:35 +01:00
Sylvain Pace
accd4f4ba6
Update/doc (#571)
* fix wrong idiom

* fixing behavior

* updating config file

* update crawler-overview

* update

* update

* update

* update

* update

* update

* update

* update

* introduce meta

* better header handling

* better header handling

* better header handling

* better header handling

* better header handling

* better header handling

* better header handling

* fix errors

* fix errors

* Update docs/src/behavior.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/recommended-configuration.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/recommended-configuration.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/recommended-configuration.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* fixing facetFilters explanation as reviewed

* fix typo

* solve equals to
2018-12-22 11:55:27 +01:00
s-pace
ccae1b6a77 consistency 2018-12-19 16:27:27 +01:00
s-pace
81367734ad better rendering 2018-12-19 16:27:27 +01:00
s-pace
938b533636 update documentation as algolia/docsearch-scraper#431 2018-12-19 16:27:27 +01:00
Tim Carry
864bc71548 Update docs/src/config-file.md
Co-Authored-By: s-pace <sylvain.pace@algolia.com>
2018-11-28 13:54:44 +01:00
s-pace
a94a777e10 update as algolia/docsearch-scraper#419 2018-11-28 13:54:44 +01:00
Sylvain Pace
9a1f15e913
Doc/update setup (#546)
* updating beahviour

* update docs/src/config-file.md

* fixing error

* Update docs/src/config-file.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/run-your-own.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/behavior.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/config-file.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/run-your-own.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/run-your-own.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* Update docs/src/run-your-own.md

Co-Authored-By: s-pace <sylvain.pace@algolia.com>

* chore(doc): Typo fixes
2018-11-27 11:35:56 +01:00
Sylvain Pace
bdce8ac5a7
Doc/recommended configuration (#505)
* adding user_agent

* promorting recomended configuration

* update image
2018-10-22 10:43:20 +02:00
Sylvain Pace
cd46aa71aa
Doc/update content (#448)
* fixing extra link

* adding  mention

* adding redundant problem

* fixing link issue

* styling fix
2018-09-10 18:32:14 +02:00
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
Pixelastic
ae520266f9 Prettify the markdown 2018-08-24 15:59:55 +02:00
Pixelastic
4dc998f01b Add write-good linting 2018-08-24 13:15:02 +02:00
Pixelastic
9fa44b531a Lint for misspelling 2018-08-24 12:36:11 +02:00
Pixelastic
dfc12b4b5e docs(lint): Lint natural language texts 2018-08-23 17:49:49 +02:00
Pixelastic
11fe0b8bc5 docs(config): Fix typo in start_urls 2018-08-22 20:11:14 +02:00
Pixelastic
9c4d0cbb30 Fix linting errors 2018-08-22 20:09:36 +02:00
Sylvain Pace
0489c213b6
Doc/update content (#422)
* # 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
2018-08-22 17:24:52 +02:00
Sylvain Pace
5e897d3f4d
Doc/update content (#419)
* # 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
2018-08-22 17:02:58 +02:00
Pixelastic
559b542980 docs(git): Remove old mark 2018-08-21 10:55:21 +02:00
Pixelastic
4d3157a0e6 Making the apply form actually post content 2018-08-20 13:24:55 +02:00
Pixelastic
d62ce0a9ba Rewriting the Run Your Own page 2018-08-20 13:24:55 +02:00
Pixelastic
b5a1d1c7a7 Finishing the config doc rewrite 2018-08-20 13:24:55 +02:00
Pixelastic
1eb2e148bd Updating config doc 2018-08-20 13:24:19 +02:00
Pixelastic
b44e7e5c71 Rewriting the essentials 2018-08-20 13:23:51 +02:00
Pixelastic
1f469a6624 Rewriting part of the documentation 2018-08-20 13:23:51 +02:00
Pixelastic
2a2b82fb6c Move all new docs to docs/ subfolder 2018-08-20 13:23:35 +02:00
Renamed from docs/source/documentation/2-docsearch-scraper/2-config-options.html.md.erb (Browse further)