Skip to content

Commit 571f188

Browse files
ravindk89djwfyirushenn
authored
Attempting to reduce docs to single platform (#1258)
## We are going to make the following changes to the Object Store docs as part of a larger QC/Content pass: ### Left Navigation We want to modify the left navigation flow to be a natural progression from a basic setup to more advanced. For example: - Core Concepts - Deployment Architecture - Availability and Resiliency - Erasure Coding and Object Healing - Object Scanner - Site Replication and Failover - Thresholds and Limits - Installation - Deployment Checklist - Deploy MinIO on Kubernetes - Deploy MinIO on Red Hat Linux - Deploy MinIO on Ubuntu Linux - Deploy MinIO for Development (MacOS, Windows, Container) - Security and Encryption (Conceptual Overview) - Network Encryption (TLS) (Conceptual overview) - Enable Network Encryption using Single Domain - Enable Network Encryption using Multiple Domains - Enable Network Encryption using certmanager (Kubernetes only) - Data Encryption (SSE) (Conceptual overview) - Enable SSE using AIStor Key Management Server - Enable SSE using KES (Summary page + linkouts) - External Identity Management (Conceptual Overview) - Enable External Identity management using OpenID - Enable External Identity management using AD/LDAP - Backup and Recovery - Create a Multi-Site Replication Configuration - Recovery after Hardware Failure - Recover after drive failure - Recover after node failure - Recover after site failure - Monitoring and Alerts - Metrics and Alerting (v3 reference) - Monitoring and Alerting using Prometheus - Monitoring and Alerting using InfluxDB - Monitoring and Alerting using Grafana - Metrics V2 Reference - Publish Server and Audit Logs to External Services - MinIO Healthcheck API The Administration, Developer, and Reference sections will remain as-is for now. http://192.241.195.202:9000/staging/singleplat/mindocs/index.html # Goals Maintaining multiple platforms is getting to be too much, and based on analytics the actual number of users taking advantage of it is minimal. Furthermore, the majority of traffic is to installation pages. Therefore we're going to try to collapse back into a single MinIO Object Storage product, and use simple navigation and on-page selectors to handle Baremetal vs Kubernetes. This may also help to eventually stage us to migrate to Hugo + Markdown --------- Co-authored-by: Daryl White <[email protected]> Co-authored-by: Rushan <[email protected]> Co-authored-by: rushenn <[email protected]>
1 parent b63d6d0 commit 571f188

File tree

105 files changed

+4788
-10279
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+4788
-10279
lines changed

‎.github/workflows/makefile.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,15 @@ jobs:
4040
name: assets
4141
compression-level: 9
4242
path: ./minio
43+
44+
- name: Publishing
45+
uses: burnett01/[email protected]
46+
with:
47+
path: ./minio/
48+
switches: --mkpath -rv --delete
49+
remote_path: ${{ secrets.DEPLOY_PATH }}/${{ github.event.pull_request.head.ref }}
50+
remote_host: ${{ secrets.DEPLOY_HOST }}
51+
remote_port: ${{ secrets.DEPLOY_PORT }}
52+
remote_user: ${{ secrets.DEPLOY_USER }}
53+
remote_key: ${{ secrets.DEPLOY_KEY }}
54+
remote_key_pass: ${{ secrets.DEPLOY_KEY_PASS }}

‎.github/workflows/minimal-build.yml‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎.github/workflows/pr-ci-cd.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Staging
2+
3+
on:
4+
pull_request:
5+
type: ["opened","synchronize"]
6+
7+
jobs:
8+
build-and-stage:
9+
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: checkout
14+
uses: actions/checkout@v4
15+
16+
- name: install-python
17+
uses: actions/setup-python@v5
18+
with:
19+
python-version: '3.12'
20+
21+
- name: pip-requirements
22+
run: pip install -r requirements.txt
23+
24+
- name: npm-setup
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: 20
28+
29+
- name: npm-install-setup
30+
uses: bahmutov/npm-install@v1
31+
with:
32+
working-directory: ./
33+
34+
- name: build-docs
35+
run: ./build-docs-ci.sh
36+
37+
- name: Staging
38+
uses: burnett01/[email protected]
39+
with:
40+
path: ./minio/
41+
switches: --mkpath -rv --delete
42+
remote_path: ${{ secrets.DEPLOY_PATH }}/${{ github.event.pull_request.head.ref }}
43+
remote_host: ${{ secrets.DEPLOY_HOST_STAGING }}
44+
remote_port: ${{ secrets.DEPLOY_PORT }}
45+
remote_user: ${{ secrets.DEPLOY_USER_STAGING }}
46+
remote_key: ${{ secrets.DEPLOY_KEY_STAGING }}
47+
remote_key_pass: ${{ secrets.DEPLOY_KEY_STAGING_PASS }}
48+
49+
- name: comment
50+
uses: actions/github-script@v7
51+
with:
52+
github-token: ${{secrets.GITHUB_TOKEN}}
53+
script: |
54+
github.rest.issues.createComment({
55+
issue_number: context.issue.number,
56+
owner: context.repo.owner,
57+
repo: context.repo.repo,
58+
body: "Staged at ${{ secrets.STAGING_URL }}/${{ github.event.pull_request.head.ref }}"
59+
})
60+
61+

‎Makefile‎

Lines changed: 8 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,9 @@ stage-%:
3434
exit 1; \
3535
fi
3636

37-
@if [ ! $(shell command -v mc) ]; then \
38-
echo "mc not found on this host, exiting" ; \
39-
exit 1; \
40-
fi
4137

42-
@if [ $(shell mc alias list --json docs-staging | jq '.status') = "error" ]; then \
43-
echo "doc-staging alias not found on for host mc configuration, exiting" ; \
44-
exit 1; \
45-
fi
38+
@(./stage.sh)
4639

47-
@if [ $(shell mc stat --json docs-staging/staging | jq '.status') = "error" ]; then \
48-
echo "docs-staging/staging bucket not found, exiting" ; \
49-
exit 1; \
50-
fi
51-
52-
@echo "Copying contents of $(BUILDDIR)/$(GITDIR)/$*/html/* to docs-staging/staging/$(GITDIR)/$*/"
53-
@mc cp -r $(BUILDDIR)/$(GITDIR)/$*/html/* docs-staging/staging/$(GITDIR)/$*/
54-
@echo "Copy complete, visit $(STAGINGURL)/$(GITDIR)/$*/index.html"
5540

5641
# Commenting out the older method
5742
# python -m http.server --directory $(BUILDDIR)/$(GITDIR)/$*/html/
@@ -65,12 +50,14 @@ stage-%:
6550
# - Compile SCSS
6651
# - Build docs via Sphinx
6752

68-
linux:
53+
mindocs:
6954
@echo "--------------------------------------"
70-
@echo "Building for $@ Platform"
55+
@echo " Building for MinIO "
7156
@echo "--------------------------------------"
7257
@cp source/default-conf.py source/conf.py
7358
@make sync-deps
59+
@make sync-operator-version
60+
@make sync-deps
7461
ifeq ($(SYNC_SDK),TRUE)
7562
@make sync-sdks
7663
else
@@ -80,91 +67,6 @@ endif
8067
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@
8168
@echo -e "Building $@ Complete\n--------------------------------------\n"
8269

83-
windows:
84-
@echo "--------------------------------------"
85-
@echo "Building for $@ Platform"
86-
@echo "--------------------------------------"
87-
@cp source/default-conf.py source/conf.py
88-
@make sync-deps
89-
@npm run build
90-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@
91-
@echo -e "Building $@ Complete\n--------------------------------------\n"
92-
93-
macos:
94-
@echo "--------------------------------------"
95-
@echo "Building for $@ Platform"
96-
@echo "--------------------------------------"
97-
@cp source/default-conf.py source/conf.py
98-
@make sync-deps
99-
@npm run build
100-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@
101-
@echo -e "Building $@ Complete\n--------------------------------------\n"
102-
103-
k8s:
104-
@echo "--------------------------------------"
105-
@echo "Building for $@ Platform"
106-
@echo "--------------------------------------"
107-
@cp source/default-conf.py source/conf.py
108-
@make sync-operator-version
109-
@make sync-deps
110-
@npm run build
111-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@
112-
@echo -e "Building $@ Complete\n--------------------------------------\n"
113-
114-
openshift:
115-
@echo "--------------------------------------"
116-
@echo "Building for $@ Platform"
117-
@echo "--------------------------------------"
118-
@cp source/default-conf.py source/conf.py
119-
@make sync-operator-version
120-
@make sync-deps
121-
@npm run build
122-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@ -t k8s
123-
@echo -e "Building $@ Complete\n--------------------------------------\n"
124-
125-
eks:
126-
@echo "--------------------------------------"
127-
@echo "Building for $@ Platform"
128-
@echo "--------------------------------------"
129-
@cp source/default-conf.py source/conf.py
130-
@make sync-operator-version
131-
@make sync-deps
132-
@npm run build
133-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@ -t k8s
134-
@echo -e "Building $@ Complete\n--------------------------------------\n"
135-
136-
gke:
137-
@echo "--------------------------------------"
138-
@echo "Building for $@ Platform"
139-
@echo "--------------------------------------"
140-
@cp source/default-conf.py source/conf.py
141-
@make sync-operator-version
142-
@make sync-deps
143-
@npm run build
144-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@ -t k8s
145-
@echo -e "Building $@ Complete\n--------------------------------------\n"
146-
147-
aks:
148-
@echo "--------------------------------------"
149-
@echo "Building for $@ Platform"
150-
@echo "--------------------------------------"
151-
@cp source/default-conf.py source/conf.py
152-
@make sync-operator-version
153-
@make sync-deps
154-
@npm run build
155-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@ -t k8s
156-
@echo -e "Building $@ Complete\n--------------------------------------\n"
157-
158-
container:
159-
@echo "--------------------------------------"
160-
@echo "Building for $@ Platform"
161-
@echo "--------------------------------------"
162-
@cp source/default-conf.py source/conf.py
163-
@make sync-deps
164-
@npm run build
165-
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)/$(GITDIR)/$@" $(SPHINXOPTS) $(O) -t $@
166-
@echo -e "Building $@ Complete\n--------------------------------------\n"
167-
16870
# Synchronization targets
16971
# Note that the @case statements are required to account for differences between Linux and MacOS binaries
17072
# Specifically, MacOS does not use GNU utils, so syntax is slightly different for things like sed
@@ -213,31 +115,8 @@ sync-minio-server-docs:
213115
@(./sync-minio-server-docs.sh)
214116

215117
sync-minio-version:
216-
@echo "Retrieving current MinIO version"
217-
$(eval DEB = $(shell curl -s https://min.io/assets/downloads-minio.json | jq '.Linux."MinIO Server".amd64.DEB.download' | sed "s|linux-amd64|linux-amd64/archive|g"))
218-
$(eval RPM = $(shell curl -s https://min.io/assets/downloads-minio.json | jq '.Linux."MinIO Server".amd64.RPM.download' | sed "s|linux-amd64|linux-amd64/archive|g"))
219-
$(eval DEBARM64 = $(shell curl -s https://min.io/assets/downloads-minio.json | jq '.Linux."MinIO Server".arm64.DEB.download' | sed "s|linux-arm64|linux-arm64/archive|g"))
220-
$(eval RPMARM64 = $(shell curl -s https://min.io/assets/downloads-minio.json | jq '.Linux."MinIO Server".arm64.RPM.download' | sed "s|linux-arm64|linux-arm64/archive|g"))
221-
$(eval MINIO = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio/releases/latest | sed "s/https:\/\/github.com\/minio\/minio\/releases\/tag\///"))
222-
223-
@$(eval kname = $(shell uname -s))
224-
225-
@case "${kname}" in \
226-
"Darwin") \
227-
sed -i "" "s|MINIOLATEST|${MINIO}|g" source/conf.py; \
228-
sed -i "" "s|DEBURL|${DEB}|g" source/conf.py; \
229-
sed -i "" "s|RPMURL|${RPM}|g" source/conf.py; \
230-
sed -i "" "s|DEBARM64URL|${DEBARM64}|g" source/conf.py; \
231-
sed -i "" "s|RPMARM64URL|${RPMARM64}|g" source/conf.py; \
232-
;; \
233-
*) \
234-
sed -i "s|MINIOLATEST|${MINIO}|g" source/conf.py; \
235-
sed -i "s|DEBURL|${DEB}|g" source/conf.py; \
236-
sed -i "s|RPMURL|${RPM}|g" source/conf.py; \
237-
sed -i "s|DEBARM64URL|${DEBARM64}|g" source/conf.py; \
238-
sed -i "s|RPMARM64URL|${RPMARM64}|g" source/conf.py; \
239-
;; \
240-
esac
118+
@echo "Retrieving MinIO latest version and download URLs"
119+
@(./sync-minio-version.sh)
241120

242121
sync-sdks:
243122
@(./sync-docs.sh)
@@ -249,7 +128,7 @@ sync-operator-crd:
249128
sync-deps:
250129
# C++ and Rust repos do not have any releases yet.
251130
@echo "Synchronizing all external dependencies"
252-
@make sync-minio-version
131+
# @make sync-minio-version
253132
@make sync-kes-version
254133
@make sync-minio-server-docs
255134

‎build-docs-ci-minimal.sh‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎build-docs-ci.sh‎

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,10 @@
33
set -ex
44

55
export PATH=${PATH}:${HOME}/.local/bin
6-
export GITDIR=main
6+
export GITDIR=$(git rev-parse --symbolic-full-name --abbrev-ref HEAD)
77

88

9-
make SYNC_SDK=TRUE linux
10-
make windows macos container k8s openshift eks aks gke
9+
make SYNC_SDK=TRUE mindocs
1110

12-
mkdir -p minio/kubernetes/upstream
13-
cp -vr build/${GITDIR}/k8s/html/* ./minio/kubernetes/upstream/
14-
15-
mkdir -p minio/kubernetes/eks
16-
cp -vr build/${GITDIR}/eks/html/* ./minio/kubernetes/eks/
17-
18-
19-
mkdir -p minio/kubernetes/gke
20-
cp -vr build/${GITDIR}/gke/html/* ./minio/kubernetes/gke/
21-
22-
mkdir -p minio/kubernetes/aks
23-
cp -vr build/${GITDIR}/aks/html/* ./minio/kubernetes/aks/
24-
25-
mkdir -p minio/kubernetes/openshift
26-
cp -vr build/${GITDIR}/openshift/html/* ./minio/kubernetes/openshift/
27-
28-
mkdir -p minio/container
29-
cp -vr build/${GITDIR}/container/html/* ./minio/container/
30-
31-
mkdir -p minio/linux
32-
cp -vr build/${GITDIR}/linux/html/* ./minio/linux/
33-
34-
mkdir -p minio/macos
35-
cp -vr build/${GITDIR}/macos/html/* ./minio/macos/
36-
37-
mkdir -p minio/windows
38-
cp -vr build/${GITDIR}/windows/html/* ./minio/windows/
11+
mkdir -p minio/
12+
cp -vr build/${GITDIR}/mindocs/html/* ./minio/

0 commit comments

Comments
 (0)