You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ho...@apache.org on 2021/01/21 15:57:52 UTC
[lucene-solr-operator] branch main updated: Make docs stable based
on the last version, store in Github Pages. (#191)
This is an automated email from the ASF dual-hosted git repository.
houston pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene-solr-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 16a5b80 Make docs stable based on the last version, store in Github Pages. (#191)
16a5b80 is described below
commit 16a5b8088ef8f7d8a78742f4ae27a3cae493f3d7
Author: Houston Putman <ho...@apache.org>
AuthorDate: Thu Jan 21 10:57:44 2021 -0500
Make docs stable based on the last version, store in Github Pages. (#191)
---
.asf.yaml | 3 +-
README.md | 20 ++++----
docs/charts/index.yaml | 106 -------------------------------------------
docs/local_tutorial.md | 2 +-
docs/running-the-operator.md | 2 +-
example/README.md | 17 +++++++
helm/solr-operator/README.md | 6 +--
7 files changed, 35 insertions(+), 121 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 64dcad3..b4103f6 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -34,8 +34,7 @@ github:
required_signatures: false
# Github Pages
- ghp_branch: main
- ghp_path: /docs
+ ghp_branch: gh-pages
notifications:
commits: commits@lucene.apache.org
diff --git a/README.md b/README.md
index 664c064..2fa0b55 100644
--- a/README.md
+++ b/README.md
@@ -31,15 +31,19 @@ Join us on the [#solr-operator](https://kubernetes.slack.com/messages/solr-opera
Please visit the following pages for documentation on using and developing the Solr Operator:
-- [Local Tutorial](docs/local_tutorial.md)
-- [Running the Solr Operator](docs/running-the-operator.md)
+- [Local Tutorial](https://apache.github.io/lucene-solr-operator/docs/local_tutorial.md)
+- [Running the Solr Operator](https://apache.github.io/lucene-solr-operator/docs/running-the-operator.md)
- Available Solr Resources
- - [Solr Clouds](docs/solr-cloud)
- - [Solr Collections](docs/solr-collection)
- - [Solr Backups](docs/solr-backup)
- - [Solr Metrics](docs/solr-prometheus-exporter)
- - [Solr Collection Aliases](docs/solr-collection-alias)
-- [Development](docs/development.md)
+ - [Solr Clouds](https://apache.github.io/lucene-solr-operator/docs/solr-cloud)
+ - [Solr Collections](https://apache.github.io/lucene-solr-operator/docs/solr-collection)
+ - [Solr Backups](https://apache.github.io/lucene-solr-operator/docs/solr-backup)
+ - [Solr Metrics](https://apache.github.io/lucene-solr-operator/docs/solr-prometheus-exporter)
+ - [Solr Collection Aliases](https://apache.github.io/lucene-solr-operator/docs/solr-collection-alias)
+- [Development](https://apache.github.io/lucene-solr-operator/docs/development.md)
+
+### Examples
+
+Example uses of each CRD have been [provided](https://apache.github.io/lucene-solr-operator/examples).
## Version Compatibility & Upgrade Notes
diff --git a/docs/charts/index.yaml b/docs/charts/index.yaml
deleted file mode 100644
index d68a3fd..0000000
--- a/docs/charts/index.yaml
+++ /dev/null
@@ -1,106 +0,0 @@
-apiVersion: v1
-entries:
- solr-operator:
- - apiVersion: v1
- appVersion: v0.2.8
- created: "2021-01-11T15:21:23.033109-05:00"
- description: The Solr Operator enables easy management of Solr resources within
- Kubernetes.
- digest: 0aafa7d978f376e368ef4d609e917ba8cd6dc087535e2777479a1b87cd65d9c9
- home: https://github.com/apache/lucene-solr-operator
- icon: https://lucene.apache.org/theme/images/solr/identity/Solr_Logo_on_white.png
- keywords:
- - solr
- - apache
- - search
- - lucene
- - operator
- kubeVersion: '>= 1.16.0-0'
- maintainers:
- - email: houston@apache.org
- name: Houston Putman
- - email: bsankaranara@bloomberg.net
- name: Balaji Sankaranarayanan
- name: solr-operator
- sources:
- - https://github.com/apache/lucene-solr-operator
- urls:
- - https://github.com/apache/lucene-solr-operator/releases/download/v0.2.8/solr-operator-0.2.8.tgz
- version: 0.2.8
- - apiVersion: v1
- appVersion: v0.2.7
- created: "2020-12-14T17:55:28.546801-05:00"
- description: The Solr Operator enables easy management of Solr resources within
- Kubernetes.
- digest: 9627073abdbd7c3ac9a0616f0582e78c6889eea9963b6ef5b38aa1e3370fd433
- home: https://github.com/apache/lucene-solr-operator
- icon: https://lucene.apache.org/theme/images/solr/identity/Solr_Logo_on_white.png
- keywords:
- - solr
- - apache
- - search
- - lucene
- - operator
- kubeVersion: '>= 1.13.0-0'
- maintainers:
- - email: houston@apache.org
- name: Houston Putman
- - email: bsankaranara@bloomberg.net
- name: Balaji Sankaranarayanan
- name: solr-operator
- sources:
- - https://github.com/apache/lucene-solr-operator
- urls:
- - https://github.com/apache/lucene-solr-operator/releases/download/v0.2.7/solr-operator-0.2.7.tgz
- version: 0.2.7
- - apiVersion: v1
- appVersion: v0.2.6
- created: "2020-08-10T15:25:32.770735-04:00"
- description: The Solr Operator enables easy management of Solr resources within
- Kubernetes.
- digest: 15ea4636403cdd7d6a565fc599c67b908f4293c0bff8d1a85dad5bc7c29311df
- home: https://github.com/apache/lucene-solr-operator
- icon: https://lucene.apache.org/theme/images/solr/identity/Solr_Logo_on_white.png
- keywords:
- - solr
- - apache
- - search
- - lucene
- - operator
- kubeVersion: '>= 1.13.0-0'
- maintainers:
- - email: houston@apache.org
- name: Houston Putman
- - email: bsankaranara@bloomberg.net
- name: Balaji Sankaranarayanan
- name: solr-operator
- sources:
- - https://github.com/apache/lucene-solr-operator
- urls:
- - https://github.com/apache/lucene-solr-operator/releases/download/v0.2.6/solr-operator-0.2.6.tgz
- version: 0.2.6
- - apiVersion: v1
- appVersion: v0.2.5
- created: "2020-05-20T12:28:07.211507-04:00"
- description: The Solr Operator enables easy management of Solr resources within
- Kubernetes.
- digest: 8ccc461fbc1ccd6c149fc34b40f049155f41131c03d291bca1f469cddb0c09dd
- home: https://github.com/apache/lucene-solr-operator
- icon: https://lucene.apache.org/theme/images/solr/identity/Solr_Logo_on_white.png
- keywords:
- - solr
- - apache
- - search
- - lucene
- - operator
- kubeVersion: '>= 1.13.0-0'
- maintainers:
- - email: houston@apache.org
- name: Houston Putman
- name: solr-operator
- sources:
- - https://github.com/apache/lucene-solr-operator
- urls:
- - https://github.com/apache/lucene-solr-operator/releases/download/v0.2.5/solr-operator-0.2.5.tgz
- version: 0.2.5
-generated: "2021-01-11T15:21:23.028609-05:00"
diff --git a/docs/local_tutorial.md b/docs/local_tutorial.md
index b1c3dd8..972211c 100644
--- a/docs/local_tutorial.md
+++ b/docs/local_tutorial.md
@@ -62,7 +62,7 @@ Before installing the Solr Operator, we need to install the [Zookeeper Operator]
Eventually this will be a dependency on the helm chart, but for now we can run an easy `kubectl apply`.
```bash
-kubectl apply -f https://raw.githubusercontent.com/apache/lucene-solr-operator/main/example/dependencies/zk_operator.yaml
+kubectl apply -f https://apache.github.io/lucene-solr-operator/example/dependencies/zk_operator.yaml
```
Now add the Solr Operator Helm repository. (You should only need to do this once)
diff --git a/docs/running-the-operator.md b/docs/running-the-operator.md
index 56a4f54..a724ab4 100644
--- a/docs/running-the-operator.md
+++ b/docs/running-the-operator.md
@@ -7,7 +7,7 @@ This is because the Solr Operator, in most instances, relies on the Zookeeper Op
Eventually this will be a dependency on the helm chart, but for now we can run an easy `kubectl apply`.
```bash
-kubectl apply -f https://raw.githubusercontent.com/apache/lucene-solr-operator/main/example/dependencies/zk_operator.yaml
+kubectl apply -f https://apache.github.io/lucene-solr-operator/example/dependencies/zk_operator.yaml
```
## Using the Solr Operator Helm Chart
diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..636f560
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,17 @@
+# Examples
+
+The following examples are provided in helping explain various options provided in each of the Solr Operator CRDs
+
+- Solr Cloud
+ - [All Encompassing](test_solrcloud.yaml)
+ - [Custom Addressability](test_solrcloud_addressability.yaml)
+ - [Private Repo Solr Image](test_solrcloud_private_repo.yaml)
+ - [Pod Tolerations](test_solrcloud_toleration_example.yaml)
+- Solr Prometheus Exporter
+ - [Basic](test_solrprometheusexporter.yaml)
+- Solr Backup
+ - [Basic](test_solrbackup.yaml)
+- Solr Collection
+ - [Basic](test_solrcollection.yaml)
+- Solr Collection Alias
+ - [Basic](test_solrcollection_alias.yaml)
\ No newline at end of file
diff --git a/helm/solr-operator/README.md b/helm/solr-operator/README.md
index 39fd3c7..08c535b 100644
--- a/helm/solr-operator/README.md
+++ b/helm/solr-operator/README.md
@@ -14,12 +14,12 @@ This is because the Solr Operator, in most instances, relies on the Zookeeper Op
If you are setting `useZkOperator=false`, then please disregard this section.
-Eventually the Zookeeper Opertor will be a dependency on the Solr Operator helm chart, but for now there are two easy ways to deploy it.
+Eventually the Zookeeper Operator will be a dependency on the Solr Operator helm chart, but for now there are two easy ways to deploy it.
- A helm chart is available [in the Zookeeper Operator repository](https://github.com/pravega/zookeeper-operator/blob/master/charts/zookeeper-operator/).
- Use the following kubectl command:
```bash
-kubectl apply -f https://raw.githubusercontent.com/apache/lucene-solr-operator/main/example/dependencies/zk_operator.yaml
+kubectl apply -f https://apache.github.io/lucene-solr-operator/example/dependencies/zk_operator.yaml
```
#### Helm
@@ -27,7 +27,7 @@ kubectl apply -f https://raw.githubusercontent.com/apache/lucene-solr-operator/m
Eventually this will be a dependency on the helm chart, but for now we can run an easy `kubectl apply`.
```bash
-kubectl apply -f https://raw.githubusercontent.com/apache/lucene-solr-operator/main/example/dependencies/zk_operator.yaml
+kubectl apply -f https://apache.github.io/lucene-solr-operator/example/dependencies/zk_operator.yaml
```
### Adding the Solr Operator Helm Chart Repository