-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump apidoc-markdown from v6.0.0 to v7.2.4 (#144007)
- Loading branch information
Thomas Watson
authored
Dec 13, 2022
1 parent
29841da
commit 47ad5ed
Showing
5 changed files
with
80 additions
and
153 deletions.
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,3 @@ | ||
# Transform Kibana API routes | ||
|
||
This folder contains Transform API routes in Kibana. | ||
|
||
Each route handler requires [apiDoc](https://github.com/apidoc/apidoc) annotations in order | ||
to generate documentation. | ||
The [apidoc-markdown](https://github.com/rigwild/apidoc-markdown) package is also required in order to generate the markdown. | ||
|
||
There are custom parser and worker (`x-pack/plugins/transform/server/routes/apidoc_scripts`) to process api schemas for each documentation entry. It's written with typescript so make sure all the scripts in the folder are compiled before executing `apidoc` command. | ||
|
||
Make sure you have run `yarn kbn bootstrap` to get all requires dev dependencies. Then execute the following command from the transform plugin folder: | ||
``` | ||
yarn run apiDocs | ||
``` | ||
It compiles all the required scripts and generates the documentation both in HTML and Markdown formats. | ||
|
||
|
||
It will create a new directory `routes_doc` (next to the `routes` folder) which contains the documentation in HTML format | ||
as well as `Transform_API.md` file. |
Oops, something went wrong.