Skip to content

Commit

Permalink
DOCS-1007: Create sync pattern to pull in the CRD during releases (#1025
Browse files Browse the repository at this point in the history
)

Closes #1007
  • Loading branch information
ravindk89 authored Oct 10, 2023
1 parent d96f3ee commit 69e291f
Show file tree
Hide file tree
Showing 8 changed files with 1,691 additions and 1 deletion.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,9 @@ sync-minio-version:
sync-sdks:
@(./sync-docs.sh)

sync-operator-crd:
@(./sync-minio-operator-crd.sh)

# Can probably safely remove this at some point
sync-deps:
# C++ and Rust repos do not have any releases yet.
Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ MinIO uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to generate
- Any GNU/Linux Operating System, or macOS 12.3 or later.
- python 3.10.x and python-pip
- python3.10-venv
- sphinx 4.3.2
- sphinx 6.2.1
- nodejs 14.5.0 or later
- npm 16.19.1 or later
- `git` or a git-compatible client
Expand Down Expand Up @@ -69,6 +69,27 @@ Does the following:
1. Check that the `build/GITDIR/linux` folder exists
2. Copies the contents of `build/GITDIR/linux/html/*` to `docs-staging/staging/GITDIR/linux`

# Syncing Operator CRD Docs

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

- pandoc (latest stable)
- asciidoc (latest stable)

In addition to all other prerequisites.

Run

```
make sync-operator-crd
```

This downloads and converts the `tenant-crd.adoc` from the MinIO Operator github repository.
It converts it to XML, then to markdown.
Finally, it does some `sed` find/replace to tidy up the file for Sphinx ingest.

You can run this when we have a new Operator release being documented, assuming there are changes to the CRD as part of that release.

# License

This project is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode). See [CONTRIBUTING.md](https://github.com/minio/docs/tree/master/CONTRIBUTING.md) guide for more information on contributing to the MinIO Documentation project.
Expand Down
10 changes: 10 additions & 0 deletions source/_static/scss/includes/_misc.scss
Original file line number Diff line number Diff line change
Expand Up @@ -370,4 +370,14 @@ figcaption {
font-size: small;
font-weight: bold;
}
}


// ---------------------------------------
// Fixing table issues from asciidoc -> md
// ---------------------------------------

table thead tr.header {
background-color: lightgray;
box-shadow: none;
}
Loading

0 comments on commit 69e291f

Please sign in to comment.