Skip to content

Commit 2a81b07

Browse files
committed
Minor cleanups
1 parent 571f188 commit 2a81b07

File tree

2 files changed

+3
-25
lines changed

2 files changed

+3
-25
lines changed

Makefile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,7 @@ sync-deps:
136136
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
137137
%: Makefile
138138
@echo -e "----------------------------------------"
139-
@echo -e "Specify one of the following supported build outputs"
140-
@echo -e "- make linux\n- make macos\n- make windows\n- make k8s\n- make openshift\n- make eks\n- make gke\n- make aks\n- make container"
139+
@echo -e "make mindocs"
141140
@echo -e "Clean targets with 'make clean-<target>'"
142141
@echo -e "Clean all targets with 'make clean'"
143142
@echo -e "----------------------------------------"

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,10 @@ python3 -m venv venv && source venv/bin/activate
3636
pip install -r requirements.txt && npm install && npm run build
3737
```
3838

39-
4. Build your desired platform targets.
39+
4. Build
4040

4141
```
42-
make linux
43-
```
44-
```
45-
make linux k8s container
42+
make mindocs
4643
```
4744

4845
5. View the generated documentation at http://localhost:8000.
@@ -51,24 +48,6 @@ make linux k8s container
5148
python -m http.server --directory build/YOUR_BRANCH/<PLATFORM>/html
5249
```
5350

54-
### Stage
55-
56-
The `make stage-PLATFORM` command uses the `mc` utility to copy the contents of the current git branch build output for the specified `PLATFORM` to a configured MinIO or S3-compatible bucket.
57-
58-
For the command to work, you must have a configured `mc` alias `docs-staging` with general read/write (`s3:*`) permissions on the `staging` bucket.
59-
The `staging` bucket should have public or anonymous access enabled.
60-
61-
For example:
62-
63-
```
64-
make stage-linux
65-
```
66-
67-
Does the following:
68-
69-
1. Check that the `build/GITDIR/linux` folder exists
70-
2. Copies the contents of `build/GITDIR/linux/html/*` to `docs-staging/staging/GITDIR/linux`
71-
7251
# Syncing Operator CRD Docs
7352

7453
For importing the Operator CRD Docs specifically, you must have:

0 commit comments

Comments
 (0)