Update README.md (s) #13
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elouanKeryell-Even
suggested changes
Mar 28, 2019
| @@ -5,5 +5,8 @@ | |||
| [ets-wfs20-dockerfile](ets-wfs20-dockerfile) | Execute ets-wfs suite tests for WFS. | |||
| [ets-cat30-dockerfile](ets-cat30-dockerfile) | Execute ets-csw suite tests for CSW. | |||
| [jsonschema2md](jsonschema2md) | Generate `.md` files based on `.json` schema. | |||
| [swagger-codegen-2.2.3](swagger-codegen/2.2.3) | Generate code from API description file in swagger format. Documentation [here](swagger-codegen/2.2.3/README.md). | |||
| [swagger-codegen-2.3.1](swagger-codegen/2.3.1) | Generate code from API description file in swagger format. Documentation [here](swagger-codegen/2.3.1/README.md). | |||
| [typedoc-dockerfile](typedoc-dockerfile) | Generate `.md` files from annotated typescipt files. Generated files have the host user UID & GID. Documentation [here](typedoc-dockerfile/README.md). | |||
There was a problem hiding this comment.
typescipt --> typo
| --mount dst=/docs,src="$PWD/project",type=bind \ | ||
| --rm \ | ||
| gisaia/swagger-codegen-2.2.3 \ |
There was a problem hiding this comment.
Typo, should be gisaia/typedocgen
| `--mount dst=/docs,src=...,type=bind,ro` | File bind-mount | Bind-mounts the typescript files from the host machine, whose path is indicated by the `src=...` parameter. | ||
| `generatedoc` | Documentation generation command| Generates the md files with the group ID and the user ID of the host machine. | ||
| | | Command line arguments | You can generate documentation from typscript files that are in a specific folder in your mounted project, just by appending it at the end of the `docker run` command (after the name of the image). Example: `specific/folder` | |
There was a problem hiding this comment.
typscript --> typo
|
@MohamedHamouGisaia Stiil relevant ? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.