generated from google/docsy-example
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Peter Mucha
committed
Jun 24, 2022
1 parent
c6a1737
commit 88983aa
Showing
69 changed files
with
696 additions
and
46 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,58 @@ | ||
|
||
--- | ||
title: "Slack Integration" | ||
linkTitle: "Slack" | ||
description: "Slack-integration for milkman" | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
--- | ||
|
||
{{% pageinfo %}} | ||
Milkman supports slack-integration via a [slackbot](https://github.com/warmuuh/milkman-slack). | ||
|
||
{{% /pageinfo %}} | ||
|
||
You can either host it yourself or use the heroku-hosted instance: | ||
|
||
[![Add to Slack](https://platform.slack-edge.com/img/add_to_slack.png)](https://milkman-slack.herokuapp.com/slack/oauth/start) | ||
|
||
# Usage | ||
|
||
Once added to your workspace, you can share a private-bin export url via: | ||
|
||
``` | ||
/milkman <privatebin-url> | ||
``` | ||
|
||
# Features | ||
|
||
It will nicely render the shared request and offers several ways for viewers to use the request, | ||
such as viewing the request as `curl`-command or `http`-request. | ||
|
||
{{< imgproc preview Resize "x500" >}} | ||
Preview of a request in slack | ||
{{< /imgproc >}} | ||
|
||
|
||
and users can choose how to view the request: | ||
|
||
{{< imgproc render Resize "x500" >}} | ||
Quick-export of a request directly in slack. | ||
{{< /imgproc >}} | ||
|
||
|
||
it also supports all other request types, such as gRPC: | ||
|
||
{{< imgproc grpc Resize "x500" >}} | ||
Example of a Grpc request in slack | ||
{{< /imgproc >}} | ||
|
||
|
||
# Planned | ||
|
||
More features are planned, such as: | ||
|
||
* execution of requests on backend | ||
* support for burn-after-reading in privatebin | ||
* more templates |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,73 @@ | ||
|
||
--- | ||
title: "Advanced Features" | ||
linkTitle: "Features" | ||
description: "Description of some more advanced Features of Milkman" | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
--- | ||
|
||
{{% pageinfo %}} | ||
Description of some more advanced Features of Milkman | ||
{{% /pageinfo %}} | ||
|
||
|
||
# Code Folding | ||
|
||
* Folding is supported in response body area | ||
* Toolbar actions: expand all, collapse all, expand one level, collapse one level | ||
* Clicking on the line-symbol expands the node | ||
* Right-Clicking on the line-symbol expands the whole subtree | ||
|
||
{{< imgproc folding Resize "x500" >}} | ||
Example of code folding | ||
{{< /imgproc >}} | ||
|
||
|
||
# Hotkeys | ||
|
||
* <kbd>CTRL</kbd>+<kbd>ENTER</kbd> - Execute Request | ||
* <kbd>CTRL</kbd>+<kbd>N</kbd> - New Request | ||
* <kbd>CTRL</kbd>+<kbd>R</kbd> - Rename Active Request | ||
* <kbd>CTRL</kbd>+<kbd>W</kbd> - Close Active Request | ||
* <kbd>CTRL</kbd>+<kbd>S</kbd> - Save Active Request | ||
* <kbd>CTRL</kbd>+<kbd>E</kbd> - Edit current Environment | ||
* <kbd>CTRL</kbd>+<kbd>Space</kbd> - Quick-Edit of Variables | ||
* <kbd>ESC</kbd> - Cancel running Request | ||
|
||
|
||
# Copy&Paste in Tables | ||
|
||
* You can <kbd>CTRL</kbd>+<kbd>C</kbd> selected rows to copy its value | ||
* You can <kbd>CTRL</kbd>+<kbd>V</kbd> multiple rows into a table | ||
|
||
{{< imgproc copypaste Resize "x500" >}} | ||
Example of Copy&Paste for tables | ||
{{< /imgproc >}} | ||
|
||
# Quick Edit for Variables | ||
|
||
* You can highlight variables. | ||
* Clicking on it opens popup for modification/creation | ||
* <kbd>ESC</kbd> hides highlighting | ||
|
||
{{< imgproc hightlight Resize "x500" >}} | ||
Example of Quick-edit for variables | ||
{{< /imgproc >}} | ||
|
||
|
||
# Keys | ||
|
||
* secret keys that should not be exported or synced can be setup using the key-symbol | ||
* currently, secret keys are only plain type keys, but will be e.g. oauth-keys etc | ||
* can be accessed using {{key:name-of-key}} variable | ||
|
||
|
||
# Libraries | ||
|
||
you can register libraries to easily look-up and import services from a central registry, such as [APIs.guru](http://apis.guru). | ||
|
||
{{< imgproc library Resize "x500" >}} | ||
Example of setting up and using Libraries | ||
{{< /imgproc >}} |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
|
||
--- | ||
title: "Milkman Plugins" | ||
linkTitle: "Plugins" | ||
--- | ||
|
||
{{% pageinfo %}} | ||
This is a placeholder page that shows you how to use this template site. | ||
{{% /pageinfo %}} | ||
|
||
|
||
This section is where the user documentation for your project lives - all the information your users need to understand and successfully use your project. |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
|
||
--- | ||
title: "Milkman Auth Plugin" | ||
linkTitle: "Authentication" | ||
description: "Contains key-types for authentication, such as oauth-authentication" | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
--- | ||
|
||
{{% pageinfo %}} | ||
Contains key-types for authentication, such as oauth-authentication | ||
{{% /pageinfo %}} | ||
|
||
|
||
# Features | ||
* supports oauth2 | ||
* password-grant, client-credential grant and authorization-code grant | ||
|
||
# Screenshot | ||
|
||
{{< imgproc auth Resize "x500" >}} | ||
Editing a secret oAuth Key (Password Grant). | ||
{{< /imgproc >}} | ||
|
||
|
||
# Remarks | ||
* does not yet support specifying a redirect-url for authorization-code as there is currently no browser included. | ||
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,44 @@ | ||
|
||
--- | ||
title: "Milkman Cassandra Plugin" | ||
linkTitle: "Cassandra" | ||
description: "Introduces Cql Requests to Milkman using cassandra datastax driver." | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
--- | ||
|
||
{{% pageinfo %}} | ||
Introduces Cql Requests to Milkman using cassandra datastax driver. | ||
{{% /pageinfo %}} | ||
|
||
# Requirements | ||
This plugin requires `milkman-jdbc` plugin | ||
|
||
# Installation | ||
After placing the jar into `\plugin` folder, you also have to place the driver-jars you want to use in that folder as well. | ||
|
||
# Usage | ||
|
||
The used url is of following format: | ||
``` | ||
cql://host[/keyspace]?dc=...[&username=...&password=...] | ||
``` | ||
|
||
supported parameters | ||
|
||
| name | description | | ||
| --- | --- | | ||
| dc | datacenter, required. for local installations, this should be 'datacenter1' | | ||
| username | username, optional | | ||
| password | password, optional | | ||
|
||
# Screenshot | ||
|
||
{{< imgproc cassandra Resize "x500" >}} | ||
Editing a secret oAuth Key (Password Grant). | ||
{{< /imgproc >}} | ||
|
||
# Features | ||
|
||
* Execution of Requests against cassandra databases |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,44 @@ | ||
|
||
--- | ||
title: "Milkman Commandline Interface" | ||
linkTitle: "Commandline Interface" | ||
description: "This is an experimental interactive command line interface for plugin." | ||
resources: | ||
- src: "**.{png,gif}" | ||
title: "Image #:counter" | ||
--- | ||
|
||
{{% pageinfo %}} | ||
This is an experimental interactive command line interface for plugin. After copying the content of the archive to the root directory of milkman, | ||
you can start it by `mm` on terminal. | ||
{{% /pageinfo %}} | ||
|
||
# Screenshot | ||
|
||
{{< imgproc cli Resize "x500" >}} | ||
Example of a cli session | ||
{{< /imgproc >}} | ||
|
||
# Features | ||
|
||
* Editing Request-Aspects via `nano` | ||
* Executing requests | ||
* Analyzing responses via `less` | ||
* Interactive mode (entered by simply starting `mm`) or non-interactive mode (by executing commands via `mm [command]`) | ||
* Tab-Completion on interactive mode | ||
|
||
# Commands | ||
|
||
* Note: all IDs are derived from the original names. All lowercase and special characters are replaced with `-`. E.g. `Your Workspace` becomes `your-workspace`* | ||
|
||
| Command | Alias | Description | Arguments | | ||
| ------ | --- | ------- | ------ | | ||
| change-workspace | ws | Switches currently activated workspace | `workspace` the id of the workspace to switch to | | ||
| change-collection | col | Switches currently activated collection | `collection` the id of the collection to switch to | | ||
| execute-request | req | Executes a given request | `requestish`<sup>1</sup> the id of the request to execute<br>`-l`, `--less` outputs response into less<br>`-v`, `--verbose` outputs all aspects | | ||
| edit-request | e | Edits an aspect of a request | `requestish`<sup>1</sup> the id of the request to execute<br>`aspect` the aspect to edit| | ||
| quit | q | Quits Application | | | ||
|
||
<sup>1</sup>A requestish is [[Workspace-Id/]Collection-Id/]Request-Id (i.e. the first two are optional) | ||
# Screenshot | ||
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
|
||
--- | ||
title: "Milkman Explore Plugin" | ||
linkTitle: "Explore" | ||
description: "JMesPath exploring for your json response." | ||
resources: | ||
- src: "**.{png,gif}" | ||
title: "Image #:counter" | ||
--- | ||
|
||
{{% pageinfo %}} | ||
Extends Milkman-rest with an additional response-tab that allows for application/json responses to be explored using JMesPath. | ||
{{% /pageinfo %}} | ||
|
||
## Note | ||
|
||
* requires milkman-rest plugin | ||
|
||
# Screenshot | ||
|
||
{{< imgproc explore Resize "x500" >}} | ||
Example of the explore plugin | ||
{{< /imgproc >}} |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.