Skip to content

Commit

Permalink
Doc: Added GA support to docs and upgraded mkdocs version
Browse files Browse the repository at this point in the history
* Added cookie consent
* Upgraded mkdocs material to 9.5.40
* Added GA
* Added feedback question
* Added Google forms feedback form
  • Loading branch information
wwoytenko committed Oct 13, 2024
1 parent 892c32d commit d94446d
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 4 deletions.
1 change: 0 additions & 1 deletion about.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- feedback
---

# About Greenmask

## Dump anonymization and synthetic data generation tool
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<meta http-equiv="refresh" content="0; url=/about/">
38 changes: 35 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: Greenmask — PostgreSQL masking and obfuscation tool
site_name: Greenmask — PostgreSQL database anonymization and synthetic data generation tool

# Theme
theme:
Expand Down Expand Up @@ -152,18 +152,50 @@ copyright: Copyright &copy; 2024 Greenmask


extra:
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
analytics:
provider: google
property: G-1LGGK7P1GD

feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by using our feedback form
<iframe
src="https://docs.google.com/forms/d/e/1FAIpQLSf6ENCSYImgNa3bNlD1S4ln8AxTVASCt_doTAC2P4Po79ffvA/viewform?embedded=true"
width="640"
height="447"
frameborder="0"
marginheight="0"
marginwidth="0">Loading…</iframe>
version:
provider: mike
social:
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/GreenmaskIO
- icon: fontawesome/brands/discord
link: https://discord.gg/97AKHdGD
link: https://discord.com/invite/rKBKvDECfd
- icon: fontawesome/brands/github
link: https://github.com/GreenmaskIO/greenmask

plugins:
- social
- search
- mike
# - macros
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ defusedxml==0.7.1
ghp-import==2.1.0
gitdb==4.0.11
GitPython==3.1.43
hjson==3.1.0
idna==3.10
importlib_metadata==8.5.0
importlib_resources==6.4.5
Expand All @@ -26,6 +27,7 @@ mkdocs-get-deps==0.2.0
mkdocs-git-authors-plugin==0.9.0
mkdocs-git-committers-plugin-2==2.4.1
mkdocs-git-revision-date-localized-plugin==1.2.9
mkdocs-macros-plugin==1.3.5
mkdocs-material==9.5.40
mkdocs-material-extensions==1.3.1
packaging==24.1
Expand All @@ -46,6 +48,8 @@ requests==2.32.3
six==1.16.0
smmap==5.0.1
soupsieve==2.6
super_collections==0.5.3
termcolor==2.5.0
tinycss2==1.3.0
urllib3==2.2.3
verspec==0.1.0
Expand Down

0 comments on commit d94446d

Please sign in to comment.