Skip to content

Commit

Permalink
added first content
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Mucha committed Jun 24, 2022
1 parent c6a1737 commit 88983aa
Show file tree
Hide file tree
Showing 69 changed files with 696 additions and 46 deletions.
Binary file added assets/favicons/favicon.ico
Binary file not shown.
Binary file added assets/icons/.DS_Store
Binary file not shown.
Binary file added assets/icons/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
78 changes: 32 additions & 46 deletions content/en/_index.html
@@ -1,7 +1,6 @@
+++
title = "Goldydocs"
linkTitle = "Goldydocs"

title = "Milkman"
linkTitle = "Milkman"
+++

{{< blocks/cover title="Milkman: A Request/Response Workbench" image_anchor="top" height="full" color="orange" >}}
Expand All @@ -18,64 +17,51 @@
{{< /blocks/cover >}}


{{% blocks/lead color="primary" %}}
Goldydocs provides a single web UI providing visibility into porridge temperature, chair size, and bed softness metrics! You can even find out who's been eating **your** porridge.

(Sadly, Goldydocs isn't a real project, but you can use this site as an example to create your own real websites with [Docsy](http://docsy.dev))
{{% blocks/lead color="blue" %}}
Milkman is heavily inspired by Postman. But I got sick of all those electron-based applications that need ages and loads of memory to start up. Therefore i created a JavaFx-based workbench for crafting requests / responses. It is not limited to e.g. http (or more specifically rest) requests. Due to nearly everything being a plugin, other things are possible, like database-requests or GRPC, GraphQl, etc...
{{% /blocks/lead %}}

{{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-lightbulb" title="New chair metrics!" %}}
The Goldydocs UI now shows chair size metrics by default.

Please follow this space for updates!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}


{{< /blocks/section >}}


{{< blocks/section >}}
{{< blocks/section color="white" >}}
<div class="col">
<h1 class="text-center">This is the second Section</h1>
<h1 class="text-center">Showcase</h1>
</div>
<div class="row">

<div class="col-lg-4 mb-5 mb-lg-0 text-center">
{{< imgproc screenshot.png Resize "x300" >}}
Screenshot of Milkman light theme
{{< /imgproc >}}
</div>
<div class="col-lg-4 mb-5 mb-lg-0 text-center">
{{< imgproc screenshot Resize "600x" >}}
Screenshot of Milkman light theme
{{< /imgproc >}}
</div>
<div class="col-lg-4 mb-5 mb-lg-0 text-center">
{{< imgproc screenshot Resize "600x" >}}
Screenshot of Milkman light theme
{{< /imgproc >}}
</div>
</div>

{{< /blocks/section >}}

{{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-gift" title="New features regularly " %}}
There are more and more plugins/features coming.


{{< blocks/section >}}
{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
Get the Goldydocs app!
Please follow this space for updates!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/warmuuh/milkman" %}}
If you have any ideas about how to improve Milkman, you are welcome to open a [Pull Request](https://github.com/warmuuh/milkman/pulls),
an [Issue](https://github.com/warmuuh/milkman/issues) or just ask in [Discussions](https://github.com/warmuuh/milkman/discussions)
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/GoHugoIO" %}}
{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/milkmanapp" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}


{{< /blocks/section >}}

{{< blocks/section >}}

<div class="col-12">
<h1 class="text-center">This is another Section</h1>
</div>

{{< /blocks/section >}}
58 changes: 58 additions & 0 deletions content/en/docs/Features/Slack/index.md
@@ -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.
Binary file added content/en/docs/Features/Slack/slack-render.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/docs/Features/copypaste.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/docs/Features/folding.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/docs/Features/hightlight-vars.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 73 additions & 0 deletions content/en/docs/Features/index.md
@@ -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 >}}
Binary file added content/en/docs/Features/milkman-library.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/docs/Plugins/.DS_Store
Binary file not shown.
12 changes: 12 additions & 0 deletions content/en/docs/Plugins/_index.md
@@ -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.
29 changes: 29 additions & 0 deletions content/en/docs/Plugins/authentication/index.md
@@ -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.
44 changes: 44 additions & 0 deletions content/en/docs/Plugins/cassandra/index.md
@@ -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
Binary file added content/en/docs/Plugins/cli/cli.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions content/en/docs/Plugins/cli/index.md
@@ -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.
23 changes: 23 additions & 0 deletions content/en/docs/Plugins/explore/index.md
@@ -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.

0 comments on commit 88983aa

Please sign in to comment.