Commit Graph
20 Commits
Author SHA1 Message Date
Alex Osborne e3f9b11394 docs: fix factual errors in user documentation (#787)
getting-started:
- Use a Java 17 path in the JAVA_HOME example (17 is the minimum)
- Link to the local Configuring Jobs page instead of the wiki
- Fix typos

operating:
- Correct --jobs-dir option name and explain its default
- Document --proxy-host, --proxy-port and --sni-host-check
- Fix option list formatting that broke rendering (-c, --web-auth)
- Remove contradictory note about credentials in heritrix_out.log
- crawl.log fetch duration is separated by '+', not ';'
- Renumber progress-statistics.log fields (field 3 was duplicated)
- Fix sourceTagSeeds property name in the XML example
- ActionDirectory is already in the default profile
- Use the correct frontier.recover.gz file name throughout
- The action directory is inside the job directory, not beside bin/

configuring-jobs:
- Fix maxDocumentsDownload, obeyRelNofollow and logger class names
- Replace removed/renamed decide rules with their current names
- Fix javadoc links for decide rules in subpackages and in engine
- Fix malformed useHTTP3 XML example and FTP/SFTP seed examples
- Replace dead Confluence glossary link
- Drop DoH caveats that only applied to Java 11 / DisableExplicitGC

api:
- Fix Create Job field list not rendering (missing blank line)
- Script engines: list Groovy/BeanShell; js and AppleScript are not
  available on supported Java versions
- Make JSON sample response consistent with the XML one

glossary:
- SHA-1 is used for content digests, not encryption
- Fix garbled Host entry (logical vs physical host)
- Fix SURT and SURT prefix examples
- Status -6 refers to DNS, not WHOIS; add -9, 1001, 2001, 2002
- Link status codes to RFC 9110 instead of RFC 2616
2026-10-13 11:34:43 +09:00
Alex Osborne b1e13c550b Add profile selector to job creation form
This means:

- Job profiles can be used without having to hunt for them among the regular jobs.
- The Groovy default profile can be selected as an alternative to Spring XML one.
- The default profiles can be customised by creating a job profile with the same name.
2026-04-27 17:40:37 +09:00
Erik Körner c1bedebef1 Add job deletion to API and UI 2026-01-05 14:19:17 +01:00
Erik Körner 76d3847f35 Update documentation 2025-12-17 18:31:16 +01: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 e08d3ad45d Note feature only applies to forthcoming 3.3 release 2018-11-03 09:30:32 +00:00
Andrew Jackson 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 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