Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-11-26 11:43:08 +03:00
Code Issues Packages Projects Releases Wiki Activity
2f5b28a1d6
hurl/docs
History
Jean-Christophe Amiel 7b6527ff16
Update docs.
2024-05-31 09:44:39 +02:00
..
assets Add GitLab CI/CD tutorial. 2023-08-08 15:12:32 +00:00
manual Update docs. 2024-05-31 09:44:39 +02:00
spec Initialize report-json option. 2024-05-19 14:50:53 +02:00
tutorial Update doc for 4.3.0. 2024-04-04 17:22:04 +02:00
asserting-response.md Add doc for isNumber predicate. 2024-04-10 12:11:33 +00:00
capturing-response.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
entry.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
filters.md format code and sort filter in order 2024-05-15 06:50:14 +00:00
frequently-asked-questions.md Update doc for 4.3.0. 2024-04-04 17:22:04 +02:00
grammar.md format code and sort filter in order 2024-05-15 06:50:14 +00:00
home.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
hurl-file.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
index.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
installation.md Update docs. 2024-05-31 09:44:39 +02:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
manual.md Initialize report-json option. 2024-05-19 14:50:53 +02:00
README.md Update Archlinux installation. 2024-04-30 13:26:50 +02:00
request.md Add proxy option documentation 2024-05-14 12:23:17 +02:00
response.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00
running-tests.md Initialize report-json option. 2024-05-19 14:50:53 +02:00
samples.md Fix sample typo for --user. 2024-04-24 15:29:10 +00:00
templates.md Update doc for 4.2.0 2024-01-10 17:13:46 +01:00

README.md

Hurl Documentation

This directory is the canonical source for Hurl documentation. The site https://hurl.dev, powered by Jekyll, is generated from it. If you want to modify https://hurl.dev, you can make a PR in this repo.

Manual Page

The canonical source for the Hurl manual pages is at https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual. The markdown files hurl.md and hurlfmt.md are used :

Dependencies:

docs/manual/hurl.md => docs/manual/hurl.1
docs/manual/hurl.md => docs/manual.md

docs/manual/hurlfmt.md => docs/manual/hurlfmt.1

READMEs

GitHub README and crates.io README are generated from the canonical docs.

Dependencies:

docs/*.md => README.md
docs/*.md => packages/hurl/README.md

Scripts

  1. generate manual
  2. generate <hurl.dev> manual
  3. generate GitHub README
  4. generate crates.io README
$ cd ..
$ python3 bin/release/gen_manpage.py docs/manual/hurl.md > docs/manual/hurl.1
$ python3 bin/release/gen_manpage.py docs/manual/hurlfmt.md > docs/manual/hurlfmt.1
$ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual.md
$ python3 bin/docs/build_readme.py github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/README.md