Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-12-25 12:05:32 +03:00
Code Issues Packages Projects Releases Wiki Activity
6379aa788f
hurl/docs
History
jcamiel 1a2a0c8f61
Update docs.
2023-04-17 18:05:07 +02:00
..
assets Update cast poster for README. 2023-01-27 10:33:26 +01:00
manual Add exit code 0 in manual 2023-04-16 13:15:20 +00:00
spec Update docs. 2023-04-17 18:05:07 +02:00
tutorial Update docs. 2023-04-17 18:05:07 +02:00
asserting-response.md Update docs. 2023-04-17 18:05:07 +02:00
capturing-response.md Fix some Hurl samples newlines. 2023-01-29 11:56:10 +01:00
entry.md Update docs for Hurl 2.0.0. 2023-01-25 11:26:30 +01:00
filters.md Update docs for Hurl 2.0.0. 2023-01-25 11:26:30 +01:00
frequently-asked-questions.md Update Hurl snippet in FAQ. 2023-02-04 00:57:17 +01:00
grammar.md Update docs. 2023-04-17 18:05:07 +02:00
home.md Update home with star links. 2023-02-07 11:05:18 +01:00
hurl-file.md Update docs for Hurl 2.0.0. 2023-01-25 11:26:30 +01:00
index.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
installation.md Use long options for curl command 2023-02-06 16:35:21 +01:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
manual.md Add exit code 0 in manual 2023-04-16 13:15:20 +00:00
README.md Rename manual-page.md to manual.md 2022-09-02 15:39:24 +02:00
request.md Add raw multipart form data sample. 2023-04-05 23:45:39 +02:00
response.md Update docs for Hurl 2.0.0. 2023-01-25 11:26:30 +01:00
running-tests.md Update docs for Hurl 2.0.0. 2023-01-25 11:26:30 +01:00
samples.md Add raw multipart form data sample. 2023-04-05 23:45:39 +02:00
templates.md Fix variables-file example 2023-02-04 20:37:14 +09: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
$ 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