1
0
mirror of https://github.com/minio/docs.git synced 2025-06-05 19:57:02 +03:00

Improve main SDK page (#1047)

Small cleanup of the main SDK index page. 

[x] More clearly link to respective Quickstarts, API references, and
GitHub repos.
[x] Reorder more-or-less by popularity.

Non-goals:
Validating the install steps provided (except replace `go get` with `go
install ...@version`)

Staged:

http://192.241.195.202:9000/staging/main-sdk-page/linux/developers/minio-drivers.html
This commit is contained in:
Andrea Longo 2023-10-25 10:59:13 -06:00 committed by GitHub
parent 1747558ffc
commit 8b4e38d48d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -12,187 +12,50 @@ Software Development Kits (SDK)
MinIO publishes the following Software Development Kits (SDK): MinIO publishes the following Software Development Kits (SDK):
1. :ref:`.NET <dotnet-sdk>` - :ref:`Go <go-sdk>`
2. :ref:`Golang <go-sdk>` - :ref:`Python <python-sdk>`
3. :ref:`Haskell <haskell-sdk>` - :ref:`Java <java-sdk>`
4. :ref:`Java <java-sdk>` - :ref:`.NET <dotnet-sdk>`
5. :ref:`JavaScript <javascript-sdk>` - :ref:`JavaScript <javascript-sdk>`
6. :ref:`Python <python-sdk>` - :ref:`C++ <cpp-sdk>`
7. :ref:`C++ <cpp-sdk>` - :ref:`Haskell <haskell-sdk>`
.. _cpp-sdk:
C++ (``minio-cpp``)
-------------------
Reference
`MinIO C++ SDK Reference <https://minio-cpp.min.io/>`__
Install
- ``vcpkg``
.. code-block:: shell
:class: copyable
vcpkg install minio-cpp
- Source
.. code-block:: shell
:class: copyable
git clone https://github.com/minio/minio-cpp
cd minio-cpp
wget --quiet -O vcpkg-master.zip https://github.com/microsoft/vcpkg/archive/refs/heads/master.zip
unzip -qq vcpkg-master.zip
./vcpkg-master/bootstrap-vcpkg.sh
./vcpkg-master/vcpkg integrate install
cmake -B ./build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=./vcpkg-master/scripts/buildsystems/vcpkg.cmake
cmake --build ./build --config Debug
.. _dotnet-sdk:
.NET (``minio-dotnet``)
-----------------------
Latest Version
|dotnet-sdk-version|
Reference
:doc:`MinIO .NET SDK Reference </developers/dotnet/minio-dotnet>`
Download from NuGet
Run the following command in the NuGet Package Manager Console.
.. code-block:: shell
:class: copyable
PM> Install-Package Minio
.. _go-sdk: .. _go-sdk:
Go (``minio-go``) Go
----------------- --
Latest Version GitHub: `minio/minio-go <https://github.com/minio/minio-go>`__
|go-sdk-version|
Reference Latest Version: |go-sdk-version|
:doc:`MinIO Go SDK Reference </developers/go/minio-go>`
Quickstart Guide: :doc:`/developers/go/minio-go`
Reference: :doc:`/developers/go/API`
Download from GitHub Download from GitHub
.. code-block:: go .. code-block:: shell
:class: copyable :class: copyable
go get github.com/minio/minio-go/v7 go install github.com/minio/minio-go/v7@latest
.. _haskell-sdk:
Haskell (``minio-hs``)
----------------------
Latest Version
|haskell-sdk-version|
Reference
:doc:`MinIO Haskell SDK Reference </developers/haskell/minio-haskell>`
Install
Add ``minio-hs`` to your project's ``.cabal`` dependencies section.
or
If you are using ``hpack``, add ``minio-hs`` to your ``package.yaml`` file.
.. _java-sdk:
Java (``minio-java``)
---------------------
Latest version
|java-sdk-version|
Reference
:ref:`MinIO Java SDK Reference <minio-java-quickstart>`
Install methods
- Maven
.. code-block:: java
:class: copyable
:substitutions:
<dependency>
<groupId>io.minio</groupId>
<artifactId>minio</artifactId>
<version>|java-sdk-version|</version>
</dependency>
- Gradle
.. code-block:: java
:class: copyable
:substitutions:
dependencies {
implementation("io.minio:minio:|java-sdk-version|")
}
- JAR
Download the latest JAR file for |java-sdk-version| of the SDK from |java-jar-url|.
.. _javascript-sdk:
JavaScript (``minio-js``)
-------------------------
Latest Version
|javascript-sdk-version|
Reference
:doc:`MinIO JavaScript SDK Reference </developers/javascript/minio-javascript>`
Install
- NPM
.. code-block:: shell
:class: copyable
npm install --save minio
- Source
.. code-block:: shell
:class: copyable
git clone https://github.com/minio/minio-js
cd minio-js
npm install
npm install -g
- TypeScript
.. code-block:: shell
:class: copyable
npm install --save-dev @types/minio
.. _python-sdk: .. _python-sdk:
Python (``minio-py``) Python
--------------------- ------
Latest Version GitHub: `minio/minio-py <https://github.com/minio/minio-py>`__
|python-sdk-version|
Latest Version: |python-sdk-version|
Quickstart Guide: :doc:`/developers/python/minio-py`
Reference: :doc:`/developers/python/API`
Reference
:doc:`MinIO Python SDK Reference </developers/python/minio-py>`
Install Methods Install Methods
- pip - pip
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
@ -207,6 +70,161 @@ Install Methods
cd minio-py cd minio-py
python setup.py install python setup.py install
.. _java-sdk:
Java
----
GitHub: `minio/minio-java <https://github.com/minio/minio-java>`__
Latest version: |java-sdk-version|
Quickstart Guide: :ref:`minio-java-quickstart`
Reference: :doc:`/developers/java/API`
Install methods
- Maven
.. code-block:: java
:class: copyable
:substitutions:
<dependency>
<groupId>io.minio</groupId>
<artifactId>minio</artifactId>
<version>|java-sdk-version|</version>
</dependency>
- Gradle
.. code-block:: java
:class: copyable
:substitutions:
dependencies {
implementation("io.minio:minio:|java-sdk-version|")
}
- JAR
Download the latest JAR file for |java-sdk-version| of the SDK from |java-jar-url|.
.. _dotnet-sdk:
.NET
----
GitHub: `minio/minio-dotnet <https://github.com/minio/minio-dotnet>`__
Latest Version: |dotnet-sdk-version|
Quickstart Guide: :doc:`/developers/dotnet/minio-dotnet`
Reference: :doc:`/developers/dotnet/API`
Download from NuGet
Run the following command in the NuGet Package Manager Console.
.. code-block:: shell
:class: copyable
PM> Install-Package Minio
.. _javascript-sdk:
JavaScript
----------
GitHub: `minio/minio-js <https://github.com/minio/minio-js>`__
Latest Version: |javascript-sdk-version|
Quickstart Guide: :doc:`/developers/javascript/minio-javascript`
Reference: :doc:`/developers/javascript/API`
Install
- NPM
.. code-block:: shell
:class: copyable
npm install --save minio
- Source
.. code-block:: shell
:class: copyable
git clone https://github.com/minio/minio-js
cd minio-js
npm install
npm install -g
- TypeScript
.. code-block:: shell
:class: copyable
npm install --save-dev @types/minio
.. _cpp-sdk:
C++
---
GitHub: `minio/minio-cpp <https://github.com/minio/minio-cpp>`__
Latest version: |cpp-sdk-version|
Reference: `MinIO C++ SDK Reference <https://minio-cpp.min.io/>`__
Install
- ``vcpkg``
.. code-block:: shell
:class: copyable
vcpkg install minio-cpp
- Source
.. code-block:: shell
:class: copyable
git clone https://github.com/minio/minio-cpp
cd minio-cpp
wget --quiet -O vcpkg-master.zip https://github.com/microsoft/vcpkg/archive/refs/heads/master.zip
unzip -qq vcpkg-master.zip
./vcpkg-master/bootstrap-vcpkg.sh
./vcpkg-master/vcpkg integrate install
cmake -B ./build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=./vcpkg-master/scripts/buildsystems/vcpkg.cmake
cmake --build ./build --config Debug
.. _haskell-sdk:
Haskell
-------
GitHub: `minio/minio-hs <https://github.com/minio/minio-hs>`__
Latest Version: |haskell-sdk-version|
Quickstart Guide: :doc:`/developers/haskell/minio-haskell`
Install
Add ``minio-hs`` to your project's ``.cabal`` dependencies section.
or
If you are using ``hpack``, add ``minio-hs`` to your ``package.yaml`` file.
.. ..
Rust SDK repo does not have any releases yet. Once released, unblock this section and add to toctree. Rust SDK repo does not have any releases yet. Once released, unblock this section and add to toctree.
@ -232,10 +250,10 @@ Install Methods
:titlesonly: :titlesonly:
:hidden: :hidden:
:maxdepth: 1 :maxdepth: 1
/developers/dotnet/minio-dotnet
/developers/go/minio-go /developers/go/minio-go
/developers/haskell/minio-haskell /developers/python/minio-py
/developers/dotnet/minio-dotnet
/developers/java/minio-java /developers/java/minio-java
/developers/javascript/minio-javascript /developers/javascript/minio-javascript
/developers/python/minio-py /developers/haskell/minio-haskell