Merge pull request #119 from fkautz/pr_out_initial_mkdocs_configuration
commit
246793e30e
@ -0,0 +1 @@ |
|||||||
|
site/ |
@ -1,17 +0,0 @@ |
|||||||
% MINIO(1) Minio Manual |
|
||||||
% Minio |
|
||||||
% December 2014 |
|
||||||
# NAME |
|
||||||
minio-get - Get an object from the store. |
|
||||||
|
|
||||||
# SYNOPSIS |
|
||||||
**minio get** |
|
||||||
BUCKET OBJECTPATH |
|
||||||
|
|
||||||
# DESCRIPTION |
|
||||||
Gets an object from a given BUCKET at the given OBJECTPATH. The object is |
|
||||||
returned on the standard output stream (STDOUT) |
|
||||||
|
|
||||||
# EXAMPLES |
|
||||||
|
|
||||||
$ minio get images /favorites/example.png > local_image.png |
|
@ -1,17 +0,0 @@ |
|||||||
% MINIO(1) Minio Manual |
|
||||||
% Minio |
|
||||||
% December 2014 |
|
||||||
# NAME |
|
||||||
minio-init - Initialize a new minio repository. |
|
||||||
|
|
||||||
# SYNOPSIS |
|
||||||
**minio init** |
|
||||||
BUCKET |
|
||||||
|
|
||||||
# DESCRIPTION |
|
||||||
Initialize a new bucket. BUCKET is the name of the new bucket. |
|
||||||
|
|
||||||
# EXAMPLES |
|
||||||
|
|
||||||
$ minio init images |
|
||||||
|
|
@ -1,19 +0,0 @@ |
|||||||
% MINIO(1) Minio Manual |
|
||||||
% Minio |
|
||||||
% December 2014 |
|
||||||
# NAME |
|
||||||
minio-put - Put an object into the store. |
|
||||||
|
|
||||||
# SYNOPSIS |
|
||||||
**minio put** |
|
||||||
BUCKET OBJECTPATH [FILE] |
|
||||||
|
|
||||||
# DESCRIPTION |
|
||||||
Adds an object to a given BUCKET at the given OBJECTPATH. An optional FILE may |
|
||||||
be provided. If no FILE is provided, the standard input stream (STDIN) is used |
|
||||||
instead. |
|
||||||
|
|
||||||
# EXAMPLES |
|
||||||
|
|
||||||
$ minio put images /favorites/example.png local_image.png |
|
||||||
$ minio put images /favorites/example2.png < local_image2.png |
|
@ -0,0 +1,3 @@ |
|||||||
|
# Management API |
||||||
|
|
||||||
|
# GET / |
@ -0,0 +1,14 @@ |
|||||||
|
# Minio API |
||||||
|
|
||||||
|
## / |
||||||
|
|
||||||
|
## GET /bucket/ |
||||||
|
|
||||||
|
## PUT /bucket/ |
||||||
|
|
||||||
|
## GET /bucket/object |
||||||
|
|
||||||
|
## HEAD /bucket/object |
||||||
|
|
||||||
|
## PUT /bucket/object |
||||||
|
|
@ -0,0 +1 @@ |
|||||||
|
# Architecture |
@ -0,0 +1,3 @@ |
|||||||
|
# Minio API |
||||||
|
|
||||||
|
## Overview |
@ -1,51 +0,0 @@ |
|||||||
Git Workflow |
|
||||||
============ |
|
||||||
|
|
||||||
Update local repo with latest changes from upstream |
|
||||||
```sh |
|
||||||
git fetch |
|
||||||
``` |
|
||||||
|
|
||||||
Create a new branch from the latest code |
|
||||||
```sh |
|
||||||
git checkout origin/master |
|
||||||
git checkout -b new_feature_branch |
|
||||||
``` |
|
||||||
|
|
||||||
```sh |
|
||||||
# do work here |
|
||||||
``` |
|
||||||
|
|
||||||
Create commit for submission |
|
||||||
```sh |
|
||||||
git commit -m "My Commit Message" |
|
||||||
``` |
|
||||||
|
|
||||||
Prepare commit for inclusion |
|
||||||
```sh |
|
||||||
git fetch |
|
||||||
git rebase origin/master |
|
||||||
``` |
|
||||||
|
|
||||||
Assuming no conflict, push to your personal fork. |
|
||||||
|
|
||||||
```sh |
|
||||||
git push myrepo new_feature_branch:new_feature_branch |
|
||||||
# Visit https://github.com/minio-io/minio and create a new pull request |
|
||||||
from your branch. |
|
||||||
``` |
|
||||||
|
|
||||||
Useful Tools |
|
||||||
------------ |
|
||||||
As an alternative to manually pushing and creating a branch, use github.com/docker/gordon pulls send command: |
|
||||||
|
|
||||||
Create a new pull request. |
|
||||||
```sh |
|
||||||
pulls send |
|
||||||
# automatically performs git push and creates pull request |
|
||||||
``` |
|
||||||
|
|
||||||
Update an existing pull request (e.g. PR 42) |
|
||||||
```sh |
|
||||||
pulls send 42 |
|
||||||
``` |
|
@ -1,42 +0,0 @@ |
|||||||
User Commands |
|
||||||
============= |
|
||||||
* put [bucket] [path] [file] |
|
||||||
* put [bucket] [path] < stdin |
|
||||||
* get [bucket] [path] > stdout |
|
||||||
* verify-bucket [bucket] |
|
||||||
* verify-object [bucket] [path] |
|
||||||
* fix-bucket [bucket] |
|
||||||
* fix-object [bucket] [path] |
|
||||||
|
|
||||||
stderr prints json on error |
|
||||||
|
|
||||||
System Commands |
|
||||||
=============== |
|
||||||
* initialize-repo |
|
||||||
* split-stream |
|
||||||
* merge-stream |
|
||||||
* encode |
|
||||||
* decode |
|
||||||
* add-to-index |
|
||||||
* add-to-store |
|
||||||
* get-from-index |
|
||||||
* get-from-store |
|
||||||
* crc |
|
||||||
* md5sum-stream |
|
||||||
* verify-repo |
|
||||||
* verify-object |
|
||||||
* whitelist-failure |
|
||||||
|
|
||||||
Potential Workflow Pseudocode (single pass) |
|
||||||
============================= |
|
||||||
```sh` |
|
||||||
add /bucket/name local-file |
|
||||||
localFile : io.Reader = open(file) |
|
||||||
md5sum-stream localFile |
|
||||||
chunks = split-file localFile |
|
||||||
for each chunk in chunks: |
|
||||||
encode chunk |
|
||||||
crc chunk |
|
||||||
add-to-store name,chunk,length,crc |
|
||||||
add-to-index name,chunkcount,md5,ts |
|
||||||
``` |
|
@ -1,10 +0,0 @@ |
|||||||
{ |
|
||||||
"source": "src", |
|
||||||
"destination": "build", |
|
||||||
"plugins": { |
|
||||||
"metalsmith-drafts": true, |
|
||||||
"metalsmith-markdown": true, |
|
||||||
"metalsmith-permalinks": "posts/:title", |
|
||||||
"metalsmith-templates": "handlebars" |
|
||||||
} |
|
||||||
} |
|
@ -0,0 +1,7 @@ |
|||||||
|
site_name: Minio Documentation |
||||||
|
pages: |
||||||
|
- ['index.md', Index] |
||||||
|
- ['api/minio.md', 'API', 'Minio'] |
||||||
|
- ['api/manage.md', 'API', 'Management'] |
||||||
|
- ['architecture.md', 'Architecture', 'Overview'] |
||||||
|
theme: readthedocs |
Loading…
Reference in new issue