From c8487079bbc8bdfa07ccec196f98270023cce10a Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Tue, 24 Oct 2023 17:01:55 -0600 Subject: [PATCH 1/3] fix links, reformat sdk index page --- source/developers/minio-drivers.rst | 218 ++++++++++++++-------------- 1 file changed, 113 insertions(+), 105 deletions(-) diff --git a/source/developers/minio-drivers.rst b/source/developers/minio-drivers.rst index 15853329..72c110dc 100644 --- a/source/developers/minio-drivers.rst +++ b/source/developers/minio-drivers.rst @@ -12,55 +12,71 @@ Software Development Kits (SDK) MinIO publishes the following Software Development Kits (SDK): -1. :ref:`.NET ` -2. :ref:`Golang ` -3. :ref:`Haskell ` -4. :ref:`Java ` -5. :ref:`JavaScript ` -6. :ref:`Python ` -7. :ref:`C++ ` +- :ref:`Go ` +- :ref:`Python ` +- :ref:`.NET ` +- :ref:`Java ` +- :ref:`JavaScript ` +- :ref:`C++ ` +- :ref:`Haskell ` -.. _cpp-sdk: +.. _go-sdk: -C++ (``minio-cpp``) -------------------- +Go +-- +GitHub: `minio/minio-go `__ -Reference - `MinIO C++ SDK Reference `__ +Latest Version: |go-sdk-version| -Install - - ``vcpkg`` +Quickstart Guide: :doc:`/developers/go/minio-go` + +Download from GitHub + .. code-block:: shell + :class: copyable + + go install github.com/minio/minio-go/v7@latest + + +.. _python-sdk: + +Python +------ + +GitHub: `minio/minio-py `__ + +Latest Version: |python-sdk-version| + +Quickstart Guide: :doc:`/developers/python/minio-py` + +Install Methods + - pip .. code-block:: shell :class: copyable - vcpkg install minio-cpp + pip3 install minio + + - source - - 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 + git clone https://github.com/minio/minio-py + cd minio-py + python setup.py install + .. _dotnet-sdk: -.NET (``minio-dotnet``) ------------------------ +.NET +---- + +GitHub: `minio/minio-dotnet `__ -Latest Version - |dotnet-sdk-version| +Latest Version: |dotnet-sdk-version| -Reference - :doc:`MinIO .NET SDK Reference ` +Quickstart Guide: :doc:`/developers/dotnet/minio-dotnet` Download from NuGet Run the following command in the NuGet Package Manager Console. @@ -70,55 +86,21 @@ Download from NuGet PM> Install-Package Minio -.. _go-sdk: - -Go (``minio-go``) ------------------ -Latest Version - |go-sdk-version| - -Reference - :doc:`MinIO Go SDK Reference ` - -Download from GitHub - .. code-block:: go - :class: copyable - - go get github.com/minio/minio-go/v7 - -.. _haskell-sdk: - -Haskell (``minio-hs``) ----------------------- - -Latest Version - |haskell-sdk-version| - -Reference - :doc:`MinIO Haskell SDK Reference ` - -Install - Add ``minio-hs`` to your project's ``.cabal`` dependencies section. - - or +.. _java-sdk: - If you are using ``hpack``, add ``minio-hs`` to your ``package.yaml`` file. +Java +---- -.. _java-sdk: +GitHub: `minio/minio-java `__ -Java (``minio-java``) ---------------------- +Latest version: |java-sdk-version| -Latest version - |java-sdk-version| +Reference: :ref:`minio-java-quickstart` -Reference - :ref:`MinIO Java SDK Reference ` - Install methods - Maven - + .. code-block:: java :class: copyable :substitutions: @@ -130,82 +112,108 @@ Install methods - 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``) -------------------------- +JavaScript +---------- -Latest Version - |javascript-sdk-version| +GitHub: `minio/minio-js `__ -Reference - :doc:`MinIO JavaScript SDK Reference ` +Latest Version: |javascript-sdk-version| + +Quickstart Guide: :doc:`/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 + npm install -g - TypeScript - + .. code-block:: shell :class: copyable npm install --save-dev @types/minio -.. _python-sdk: -Python (``minio-py``) ---------------------- +.. _cpp-sdk: -Latest Version - |python-sdk-version| +C++ +--- + +GitHub: `minio/minio-cpp `__ + +Latest version: |cpp-sdk-version| + +Reference: `MinIO C++ SDK Reference `__ + +Install + - ``vcpkg`` -Reference - :doc:`MinIO Python SDK Reference ` - -Install Methods - - pip - .. code-block:: shell :class: copyable - pip3 install minio + vcpkg install minio-cpp - - source + - Source .. code-block:: shell :class: copyable - git clone https://github.com/minio/minio-py - cd minio-py - python setup.py install + 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 `__ + +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. @@ -232,10 +240,10 @@ Install Methods :titlesonly: :hidden: :maxdepth: 1 - - /developers/dotnet/minio-dotnet + /developers/go/minio-go - /developers/haskell/minio-haskell + /developers/python/minio-py + /developers/dotnet/minio-dotnet /developers/java/minio-java /developers/javascript/minio-javascript - /developers/python/minio-py + /developers/haskell/minio-haskell From f434fab9241c5c483cc554aac855eb78e8b8cd8d Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Wed, 25 Oct 2023 09:36:19 -0600 Subject: [PATCH 2/3] change ordering --- source/developers/minio-drivers.rst | 42 ++++++++++++++--------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/source/developers/minio-drivers.rst b/source/developers/minio-drivers.rst index 72c110dc..cb0efc9d 100644 --- a/source/developers/minio-drivers.rst +++ b/source/developers/minio-drivers.rst @@ -14,8 +14,8 @@ MinIO publishes the following Software Development Kits (SDK): - :ref:`Go ` - :ref:`Python ` -- :ref:`.NET ` - :ref:`Java ` +- :ref:`.NET ` - :ref:`JavaScript ` - :ref:`C++ ` - :ref:`Haskell ` @@ -67,26 +67,6 @@ Install Methods python setup.py install -.. _dotnet-sdk: - -.NET ----- - -GitHub: `minio/minio-dotnet `__ - -Latest Version: |dotnet-sdk-version| - -Quickstart Guide: :doc:`/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 - - .. _java-sdk: Java @@ -126,6 +106,26 @@ Install methods Download the latest JAR file for |java-sdk-version| of the SDK from |java-jar-url|. +.. _dotnet-sdk: + +.NET +---- + +GitHub: `minio/minio-dotnet `__ + +Latest Version: |dotnet-sdk-version| + +Quickstart Guide: :doc:`/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 + + .. _javascript-sdk: JavaScript From a6eeba73297b8f9d7fb41c4f2c9d0c4a840f8702 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Wed, 25 Oct 2023 10:56:35 -0600 Subject: [PATCH 3/3] link other api ref pages --- source/developers/minio-drivers.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/source/developers/minio-drivers.rst b/source/developers/minio-drivers.rst index cb0efc9d..6bc741a9 100644 --- a/source/developers/minio-drivers.rst +++ b/source/developers/minio-drivers.rst @@ -31,6 +31,8 @@ Latest Version: |go-sdk-version| Quickstart Guide: :doc:`/developers/go/minio-go` +Reference: :doc:`/developers/go/API` + Download from GitHub .. code-block:: shell :class: copyable @@ -49,6 +51,8 @@ Latest Version: |python-sdk-version| Quickstart Guide: :doc:`/developers/python/minio-py` +Reference: :doc:`/developers/python/API` + Install Methods - pip @@ -76,7 +80,9 @@ GitHub: `minio/minio-java `__ Latest version: |java-sdk-version| -Reference: :ref:`minio-java-quickstart` +Quickstart Guide: :ref:`minio-java-quickstart` + +Reference: :doc:`/developers/java/API` Install methods - Maven @@ -117,6 +123,8 @@ 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. @@ -137,6 +145,8 @@ Latest Version: |javascript-sdk-version| Quickstart Guide: :doc:`/developers/javascript/minio-javascript` +Reference: :doc:`/developers/javascript/API` + Install - NPM