minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-18 10:04:02 +03:00
Code

Fixing issues after multiple large merges

Browse Source
This commit is contained in:
Ravind Kumar 2023-01-10 17:44:40 -05:00
parent 9b7a95d2b2
commit 9ae1e87c75
12 changed files with 36 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
build-docs.sh
View File

@ -13,12 +13,24 @@ pip install -r requirements.txt
make clean
make SYNC_SDK=TRUE linux
make windows macos container k8s openshift
make windows macos container k8s openshift eks aks gke
sudo rm -rf /var/www/docs/minio/kubernetes/upstream
sudo mkdir -p /var/www/docs/minio/kubernetes/upstream
sudo cp -vr build/${branch}/k8s/html/* /var/www/docs/minio/kubernetes/upstream/
sudo rm -rf /var/www/docs/minio/kubernetes/eks
sudo mkdir -p /var/www/docs/minio/kubernetes/eks
sudo cp -vr build/${branch}/eks/html/* /var/www/docs/minio/kubernetes/eks/
sudo rm -rf /var/www/docs/minio/kubernetes/gke
sudo mkdir -p /var/www/docs/minio/kubernetes/gke
sudo cp -vr build/${branch}/gke/html/* /var/www/docs/minio/kubernetes/gke/
sudo rm -rf /var/www/docs/minio/kubernetes/aks
sudo mkdir -p /var/www/docs/minio/kubernetes/aks
sudo cp -vr build/${branch}/aks/html/* /var/www/docs/minio/kubernetes/aks/
sudo rm -rf /var/www/docs/minio/kubernetes/openshift
sudo mkdir -p /var/www/docs/minio/kubernetes/openshift
sudo cp -vr build/${branch}/openshift/html/* /var/www/docs/minio/kubernetes/openshift/

4
new-platform.md
View File

@ -22,11 +22,15 @@ When launching docs for a new `$program` or `$platform`, the following steps mus
- Use an existing `elif` section as a template to follow.
- This allows you to exclude files that are not necessary from the build.
- Use the `url-excludes.yaml` file to specify URLs to exclude from that platforms build
3. Update `build-docs.sh` in this repo to automatically build the docs for the web server on each merge to the `main` branch
- Add the platform or program to the second `make` line.
- Create the commands to clear and add the path to the new docs using an existing section as a template.
- Kubernetes platforms should go under `/docs/kubernetes/$platform`
- You can test by running locally (might need `sudo sh ./build-docs.sh`).
You can then use `python -m http.server --directory /var/www/docs/minio/` and testing URLs
4. Update the doc main nav bar (`/source/_templates/content-navigation.html`) to include the `$program` and/or `$platform`

4
source/_templates/platform-navigation.html
View File

@ -42,8 +42,8 @@
<div class="platform-nav__dropdown">
<div class="container">
<nav id="cn-kubernetes" class="{{ 'active' if doc_platform == 'kubernetes' or doc_platform == 'openshift' or doc_platform == 'eks' or doc_platform == 'gke' or doc_platform == 'aks' }}">
<a rel="noreferrer" href="/docs/minio/kubernetes/upstream/index.html" class="{{ 'active' if doc_platform == 'kubernetes' }}">Upstream</a>
<nav id="cn-kubernetes" class="{{ 'active' if doc_platform == 'k8s' or doc_platform == 'openshift' or doc_platform == 'eks' or doc_platform == 'gke' or doc_platform == 'aks' }}">
<a rel="noreferrer" href="/docs/minio/kubernetes/upstream/index.html" class="{{ 'active' if doc_platform == 'k8s' }}">Upstream</a>
<a rel="noreferrer" href="/docs/minio/kubernetes/openshift/index.html" class="{{ 'active' if doc_platform == 'openshift' }}">Redhat Openshift</a>
<a rel="noreferrer" href="/docs/minio/kubernetes/eks/index.html" class="{{ 'active' if doc_platform == 'eks' }}">Amazon Elastic Kubernetes Service</a>
<a rel="noreferrer" href="/docs/minio/kubernetes/gke/index.html" class="{{ 'active' if doc_platform == 'gke' }}">Google Kubernetes Engine</a>

2
source/administration/object-management/transition-objects-to-azure.rst
View File

@ -117,7 +117,7 @@ Procedure
2) Configure the Remote Storage Tier
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use the :mc-cmd:`mc ilm tier add` command to add a new remote storage tier:
Use the :mc:`mc ilm tier add` command to add a new remote storage tier:
.. code-block:: shell
:class: copyable

2
source/administration/object-management/transition-objects-to-gcs.rst
View File

@ -115,7 +115,7 @@ Procedure
2) Configure the Remote Storage Tier
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use the :mc-cmd:`mc ilm tier add` command to add a new Google Cloud Storage
Use the :mc:`mc ilm tier add` command to add a new Google Cloud Storage
service as the remote storage tier:
.. code-block:: shell

2
source/administration/object-management/transition-objects-to-s3.rst
View File

@ -124,7 +124,7 @@ Procedure
2) Configure the Remote Storage Tier
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use the :mc-cmd:`mc ilm tier add` command to add an Amazon S3 service as the
Use the :mc:`mc ilm tier add` command to add an Amazon S3 service as the
new remote storage tier:
.. code-block:: shell

2
source/includes/k8s/install-minio-kubectl-plugin.rst
View File

@ -19,7 +19,7 @@ You can install the MinIO plugin using either the Kubernetes Krew plugin manager
If you want to update the MinIO plugin with Krew, use the following command:
.. code-block:: shell
:class copyable
:class: copyable
kubectl krew upgrade minio

2
source/operations/install-deploy-manage/migrate-fs-gateway.rst
View File

@ -135,7 +135,7 @@ Procedure
#. *(Optional)* Duplicate **tiers** from existing standalone deployment to new deployment
Use :mc-cmd:`mc ilm tier ls` with the ``--json`` flag to retrieve a list of the tiers that exist on the standalone deployment.
Use :mc:`mc ilm tier ls` with the ``--json`` flag to retrieve a list of the tiers that exist on the standalone deployment.
.. code-block:: shell
:class: copyable

4
source/reference/minio-mc-deprecated.rst
View File

@ -65,7 +65,7 @@ Table of Deprecated Admin Commands
- Version of Change
* - ``mc admin tier add``
- :mc-cmd:`mc ilm tier add`
- :mc:`mc ilm tier add`
- mc RELEASE.2022-12-24T15-21-38Z
* - ``mc admin tier edit``
@ -73,7 +73,7 @@ Table of Deprecated Admin Commands
- mc RELEASE.2022-12-24T15-21-38Z
* - ``mc admin tier ls``
- :mc-cmd:`mc ilm tier ls`
- :mc:`mc ilm tier ls`
- mc RELEASE.2022-12-24T15-21-38Z
* - ``mc admin bucket remote add``

2
source/reference/minio-mc/mc-ilm-tier-add.rst
View File

@ -14,7 +14,7 @@
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
:mc-cmd:`mc ilm tier add` replaces ``mc admin tier add``.
:mc:`mc ilm tier add` replaces ``mc admin tier add``.
Description
-----------

2
source/reference/minio-mc/mc-ilm-tier-ls.rst
View File

@ -14,7 +14,7 @@
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
:mc-cmd:`mc ilm tier ls` replaces ``mc admin tier ls``.
:mc:`mc ilm tier ls` replaces ``mc admin tier ls``.
Description
-----------

8
source/url-excludes.yaml
View File

@ -35,6 +35,7 @@ excludes:
- 'reference/kubectl-minio-plugin*'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'
---
@ -51,6 +52,7 @@ excludes:
- 'reference/kubectl-minio-plugin*'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'
---
@ -69,6 +71,7 @@ excludes:
- 'reference/kubectl-minio-plugin*'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'
---
@ -84,6 +87,7 @@ excludes:
- 'operations/manage-existing-deployments.rst'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'
---
@ -99,6 +103,7 @@ excludes:
- 'operations/manage-existing-deployments.rst'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'
---
@ -114,6 +119,7 @@ excludes:
- 'operations/manage-existing-deployments.rst'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'
---
@ -129,6 +135,7 @@ excludes:
- 'operations/manage-existing-deployments.rst'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'
---
@ -144,5 +151,6 @@ excludes:
- 'operations/manage-existing-deployments.rst'
- 'reference/minio-server*'
- 'reference/minio-mc*'
- 'reference/deprecated/*'
- 'developers/*'
- 'integrations/*'