Alex Osborne
4a5fdcfaf0
docs: Add remaining link extractor to the bean reference
2021-07-12 09:23:08 +09:00
Alex Osborne
d10be35f0c
docs: Remove duplicate word 'Documentation' from page titles
...
Also include '3' to distinguish from the Heritrix 1 manual which is
still prevalent in search results.
2021-07-12 09:10:57 +09:00
Alex Osborne
63bd15535d
docs: Fix links accidentally using Markdown syntax
2021-07-12 09:09:17 +09:00
Alex Osborne
b3be9d01fe
docs: Start a 'Bean Reference' document generated from the source code
...
This is meant to complement the javadoc by providing a reference
more suitable for users trying to configure crawls rather than
developers writing new modules.
The doc generation could still do with some improving and some of the
source javadoc comments need fixing up but this is already useful so I'm
committing what I have so far.
2021-07-11 15:56:37 +09:00
Alex Osborne
3f20e736d5
docs: Fix incorrectly indented line causing rst warning
2021-07-10 21:11:03 +09:00
Alex Osborne
503e40cfce
docs: Add sections on FTP, SFTP and WHOIS to config guide
2021-07-10 21:09:52 +09:00
Alex Osborne
c2c2b244de
docs: Add a plugin for basic auto-generation of bean examples
2021-07-10 21:09:17 +09:00
Alex Osborne
6fb699c780
docs: s/Most/More/ documentation lives on the wiki
...
A large amount of core documentation has now been migrated here. There's
still a lot to go but I don't think 'most' applies anymore.
2021-07-10 12:42:17 +09:00
Alex Osborne
9b1919dbd3
docs: Remove inaccurate 2018 date from documentation footer
...
Large portions of the docs were first published much earlier in other
places and some have been updated since then. Rather than trying to
keep a date range up to date let's just remove the date. We don't use
dates in the source code boilerplate and my understanding is copyright
notices are not mandatory in almost all countries due to the Berne
Convention anyway so it's really just informational.
2021-07-10 12:37:35 +09:00
Alex Osborne
b680bb206b
docs: Add subdirectory explanation from wiki install page
2021-07-10 12:13:26 +09:00
Alex Osborne
a84e0bb792
docs: Add an operating guide based on the contents of the wiki
2021-07-07 21:30:36 +09:00
Alex Osborne
507d7d91a3
docs: add getting-started.rst, configuring-jobs.rst and glossary.rst
...
Compiled from the wiki with some restructuring, reformatting and
updating for the current version of Heritrix.
2021-07-06 22:44:11 +09:00
Alex Osborne
f19dacfe67
Document GET /engine
2020-04-20 18:32:43 +09:00
Alex Osborne
f442f76784
Add missing newline
2020-04-20 12:47:17 +09:00
Alex Osborne
33e637b887
Correct indentation to 3-spaces for reST
2020-04-20 12:40:51 +09:00
Alex Osborne
75dc16e8ca
Document 'Get Job Status' endpoint
2020-04-20 12:35:49 +09:00
Andy Jackson and GitHub
e08d3ad45d
Note feature only applies to forthcoming 3.3 release
2018-11-03 09:30:32 +00:00
Andrew Jackson and Alex Osborne
3a299d7899
Update API with note about checkpoint launching.
2018-11-01 20:20:17 +09:00
Alex Osborne
da9fcf1af6
Fix typos
2018-07-04 22:22:15 +09:00
Alex Osborne
2d48b40ea4
Replace API response section with statuscode tag
2018-07-04 21:46:42 +09:00
Alex Osborne
0cfd62f76e
Reformat the rest of the API calls
2018-07-04 21:43:57 +09:00
Alex Osborne
3b3d579cb8
Add actions to API URLs to distinguish them
2018-07-04 21:16:53 +09:00
Alex Osborne
1ff31c135e
Add explanatory note about documentation
2018-07-04 19:48:33 +09:00
Alex Osborne
7076dd6388
Try nicer formatting for the first API example
2018-07-04 18:46:15 +09:00
Alex Osborne
ab8a5efea2
Format HTTP request lines in API guide
2018-07-04 18:24:08 +09:00
Alex Osborne
e35eb9e850
Move conventions and REST section to the end of the document
...
Let's dive right into the API. Chances are anyone who wants to use
the REST API already knows what it is. :-)
2018-07-04 17:53:05 +09:00
Alex Osborne
57f465706e
Convert html tables to rst tables
2018-07-04 17:34:19 +09:00
Alex Osborne
90db2e33d5
Add skeleton sphinx docs for readthedocs
2018-07-04 16:40:51 +09:00
Alex Osborne