Skip to content

Commit f1965da

Browse files
committed
clarified zplane free usage
1 parent db0fea8 commit f1965da

File tree

5 files changed

+33
-1
lines changed

5 files changed

+33
-1
lines changed

Diff for: .gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
site
22
.DS_Store
33
.idea
4+
5+
venv
6+
7+
# .gitognore for python
8+
*.py[cod]
9+
*$py.class
10+
__pycache__/
11+

Diff for: README.md

+12
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Documentation is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
44

5+
6+
## dev containers
7+
58
Best way to start with updating documentation is to open this repo using [vs code dev containers](https://code.visualstudio.com/docs/remote/containers)
69

710
You will need to fix/delete/comment mounts section in `.devcontainer/devcontainer.json` before you open the repo in dev container.
@@ -24,3 +27,12 @@ To generate docs without vscode run below command
2427
docker run --rm -it -v $PWD:/site squidfunk/mkdocs-material build
2528
```
2629

30+
## virtual environment
31+
32+
You can use python virtual environment to do development as well
33+
34+
```sh
35+
source setup_env.sh
36+
mkdocs serve
37+
```
38+

Diff for: docs/zplane.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Currently following features are part of enterprise offering through zPlane:
1313

1414
# zPlane
1515

16-
⚠️ zPlane is commercial software that needs to be licensed before you can use it in production. You can get zPlane from <https://gallery.ecr.aws/zinclabs/zplane> for evaluation purposes. Please contact us at [hello@zinclabs.io](mailto:hello@zinclabs.io) for enquiries or enterprise license.
16+
⚠️ zPlane is commercial software that needs to be licensed before you can use it in production. You can get zPlane from <https://gallery.ecr.aws/zinclabs/zplane> for evaluation purposes. Please contact us at [hello@openobserve.ai](mailto:hello@openobserve.ai) for enquiries or enterprise license. zPlane can be used freely for personal and non-commercial usage.
1717

1818
zPlane is collection of adapters & utilities to be used with OpenObserve, augmenting functionalities of OpenObserve.
1919

Diff for: requirements.txt

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ aiohttp==3.8.4
22
aiosignal==1.3.1
33
async-timeout==4.0.2
44
attrs==23.1.0
5+
bracex==2.3.post1
56
certifi==2023.5.7
67
charset-normalizer==3.1.0
78
click==8.1.3
@@ -20,10 +21,12 @@ material-plausible-plugin==0.2.0
2021
md-translate==2.1.0
2122
mergedeep==1.3.4
2223
mkdocs==1.4.3
24+
mkdocs-awesome-pages-plugin==2.9.2
2325
mkdocs-material==9.1.15
2426
mkdocs-material-extensions==1.1.1
2527
multidict==6.0.4
2628
multiprocess==0.70.14
29+
natsort==8.4.0
2730
openai==0.27.7
2831
packaging==23.1
2932
pathos==0.3.0
@@ -42,4 +45,5 @@ tqdm==4.65.0
4245
translators==4.11.4
4346
urllib3==2.0.2
4447
watchdog==3.0.0
48+
wcmatch==8.4.1
4549
yarl==1.9.2

Diff for: setup_env.sh

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/bin/sh
2+
3+
pip install virtualenv
4+
virtualenv venv
5+
source venv/bin/activate
6+
pip install -r requirements.txt
7+
8+

0 commit comments

Comments
 (0)