Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-09-11 05:35:53 +03:00
Code Issues Packages Projects Releases Wiki Activity
2e3eaca3d4
hurl/docs
History
Christine Seeman 2e3eaca3d4 Changing naming from Manual Page to just Manual 
Where it made sense in the titles, and references in the documentation,
I have updated to just `Manual` over `Manual Page` for clarity on the
purpose of the section or documentation. I have left the file naming
alone, since that was mostly used in the links and felt like the titles
might be where more confusion could be at.
2022-09-02 12:47:08 +02:00
..
assets/img Import of the canonical docs (raw Markdown, without ant Jekyll specificities.) 2022-06-01 10:34:33 +02:00
manual Adding pluralization to scenerio and documentation 2022-09-02 12:47:08 +02:00
spec Add option variable 2022-09-02 10:25:35 +02:00
tutorial Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
asserting-response.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
capturing-response.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
entry.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
frequently-asked-questions.md Update shell Hurl snippets with colored output. 2022-08-17 18:30:59 +02:00
grammar.md Delete legacy grammar. 2022-06-20 19:16:57 +02:00
home.md Update READMEs 2022-06-13 09:04:29 +02:00
hurl-file.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
index.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
installation.md Fix minor typo on docs. 2022-08-28 23:26:11 +02:00
license.md Add licence.md in docs. 2022-06-05 17:33:06 +02:00
manual-page.md Changing naming from Manual Page to just Manual 2022-09-02 12:47:08 +02:00
README.md Changing naming from Manual Page to just Manual 2022-09-02 12:47:08 +02:00
request.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
response.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
running-tests.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
samples.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02:00
templates.md Changing to manual vs man in documenation 2022-09-02 12:47:08 +02: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 :

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

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

READMEs

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

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-page.md
$ python3 bin/docs/build_readme.py github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/README.md