1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +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

View File

@ -12,109 +12,77 @@ 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``) .. _python-sdk:
----------------------
Latest Version Python
|haskell-sdk-version| ------
Reference GitHub: `minio/minio-py <https://github.com/minio/minio-py>`__
:doc:`MinIO Haskell SDK Reference </developers/haskell/minio-haskell>`
Install Latest Version: |python-sdk-version|
Add ``minio-hs`` to your project's ``.cabal`` dependencies section.
or Quickstart Guide: :doc:`/developers/python/minio-py`
Reference: :doc:`/developers/python/API`
Install Methods
- pip
.. code-block:: shell
:class: copyable
pip3 install minio
- source
.. code-block:: shell
:class: copyable
git clone https://github.com/minio/minio-py
cd minio-py
python setup.py install
If you are using ``hpack``, add ``minio-hs`` to your ``package.yaml`` file.
.. _java-sdk: .. _java-sdk:
Java (``minio-java``) Java
--------------------- ----
Latest version GitHub: `minio/minio-java <https://github.com/minio/minio-java>`__
|java-sdk-version|
Reference Latest version: |java-sdk-version|
:ref:`MinIO Java SDK Reference <minio-java-quickstart>`
Quickstart Guide: :ref:`minio-java-quickstart`
Reference: :doc:`/developers/java/API`
Install methods Install methods
- Maven - Maven
@ -143,16 +111,41 @@ Install methods
Download the latest JAR file for |java-sdk-version| of the SDK from |java-jar-url|. 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-sdk:
JavaScript (``minio-js``) JavaScript
------------------------- ----------
Latest Version GitHub: `minio/minio-js <https://github.com/minio/minio-js>`__
|javascript-sdk-version|
Reference Latest Version: |javascript-sdk-version|
:doc:`MinIO JavaScript SDK Reference </developers/javascript/minio-javascript>`
Quickstart Guide: :doc:`/developers/javascript/minio-javascript`
Reference: :doc:`/developers/javascript/API`
Install Install
- NPM - NPM
@ -179,33 +172,58 @@ Install
npm install --save-dev @types/minio npm install --save-dev @types/minio
.. _python-sdk:
Python (``minio-py``) .. _cpp-sdk:
---------------------
Latest Version C++
|python-sdk-version| ---
Reference GitHub: `minio/minio-cpp <https://github.com/minio/minio-cpp>`__
:doc:`MinIO Python SDK Reference </developers/python/minio-py>`
Install Methods Latest version: |cpp-sdk-version|
- pip
Reference: `MinIO C++ SDK Reference <https://minio-cpp.min.io/>`__
Install
- ``vcpkg``
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
pip3 install minio vcpkg install minio-cpp
- source - Source
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
git clone https://github.com/minio/minio-py git clone https://github.com/minio/minio-cpp
cd minio-py cd minio-cpp
python setup.py install 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.
@ -233,9 +251,9 @@ Install Methods
: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