Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-11-22 15:42:20 +03:00
Code Issues Packages Projects Releases Wiki Activity
3361aaaf24
hurl/docs/README.md

58 lines
2.0 KiB
Markdown
Raw Normal View History

Update man and README.
2022-08-16 13:08:14 +03:00
# Hurl Documentation
This directory is the canonical source for Hurl documentation. The site <https://hurl.dev>, powered by Jekyll,
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
is generated from it. If you want to modify <https://hurl.dev>, you can make a PR in this repo.
Update man and README.
2022-08-16 13:08:14 +03:00
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
## Manual Page
Update man and README.
2022-08-16 13:08:14 +03:00
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
The canonical source for the Hurl manual pages is at <https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual>.
Update man and README.
2022-08-16 13:08:14 +03:00
The markdown files [`hurl.md`] and [`hurlfmt.md`] are used :
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
- to generate manual pages [`hurl.1`] and [`hurlfmt.1`]
Rename manual-page.md to manual.md
2022-09-02 15:45:54 +03:00
- to generate Markdown documentation page [`manual.md`] for <https://hurl.dev>
Dependencies:
Update man and README.
2022-08-16 13:08:14 +03:00
```
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
docs/manual/hurl.md => docs/manual/hurl.1
Rename manual-page.md to manual.md
2022-09-02 15:45:54 +03:00
docs/manual/hurl.md => docs/manual.md
Update man and README.
2022-08-16 13:08:14 +03:00
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
docs/manual/hurlfmt.md => docs/manual/hurlfmt.1
Update man and README.
2022-08-16 13:08:14 +03:00
```
## READMEs
[GitHub README] and [crates.io README] are generated from the canonical docs.
Rename manual-page.md to manual.md
2022-09-02 15:45:54 +03:00
Dependencies:
Update man and README.
2022-08-16 13:08:14 +03:00
```
docs/*.md => README.md
docs/*.md => packages/hurl/README.md
```
Update man and document documentation generation.
2022-08-16 15:17:44 +03:00
## Scripts
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 01:29:23 +03:00
1. generate manual
2. generate <hurl.dev> manual
Update man and document documentation generation.
2022-08-16 15:17:44 +03:00
3. generate GitHub README
4. generate crates.io README
```bash
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
$ 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
Rename manual-page.md to manual.md
2022-09-02 15:45:54 +03:00
$ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual.md
Update man and document documentation generation.
2022-08-16 15:17:44 +03:00
$ python3 bin/docs/build_readme.py github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/README.md
```
Update man and README.
2022-08-16 13:08:14 +03:00
Changing to manual vs man in documenation In intro documentation, it can be confusing to see just `man` for the reference to reference manual pages and documentation. I believe this is a reference to Unix man pages (manual pages), but markdown is much more than what those ASCII text displays could do. To help understandability, I am submitting a PR to update some documentation references to manual over man.
2022-08-31 19:14:45 +03:00
[`hurl.md`]: https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual/hurl.md
[`hurlfmt.md`]: https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual/hurlfmt.md
[`hurl.1`]: https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual/hurl.1
[`hurlfmt.1`]: https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual/hurlfmt.1
Rename manual-page.md to manual.md
2022-09-02 15:45:54 +03:00
[`manual.md`]: https://github.com/Orange-OpenSource/hurl/blob/master/docs/manual.md
Update man and README.
2022-08-16 13:08:14 +03:00
[GitHub README]: https://github.com/Orange-OpenSource/hurl/blob/master/README.md
[crates.io README]: https://github.com/Orange-OpenSource/hurl/blob/master/packages/hurl/README.md
Reference in New Issue Copy Permalink