[INT-398] Update UCC docs

censys · Feb 2, 2023 · 241c8e8 · 241c8e8
1 parent 6d146c6
commit 241c8e8
Show file tree

Hide file tree

Showing 31 changed files with 2,895 additions and 1,995 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -17,7 +17,7 @@ variables:
 
   variables:
     PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
-    POETRY_VERSION: 1.2.0
+    POETRY_VERSION: 1.3.2
 
   cache:
     key:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -43,6 +43,7 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
+
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.33.0
     hooks:

diff --git a/Dockerfile b/Dockerfile
@@ -11,7 +11,7 @@ ENV PYTHONUNBUFFERED=1 \
     PIP_DISABLE_PIP_VERSION_CHECK=on \
     PIP_DEFAULT_TIMEOUT=100 \
     POETRY_NO_INTERACTION=1 \
-    POETRY_VERSION=1.2.2 \
+    POETRY_VERSION=1.3.2 \
     PIP_VERSION=22.2.2 \
     SETUPTOOLS_VERSION=65.3.0
 

diff --git a/README.md b/README.md
@@ -17,12 +17,14 @@ providers: AWS, Azure, and GCP. Please see our
 
 Please view our documentation on [Read the Docs][censys-cloud-connector-docs].
 
-## Developer Documentation
+## Contributing
 
 All contributions (no matter how small) are always welcome. See
 [Contributing to the Cloud Connector][contributing] to change or
 test the code or for information on the CI/CD pipeline.
 
+Submit an issue or pull request on [GitHub][github-issues].
+
 ## License
 
 This software is licensed under [Apache License, Version 2.0][license].
@@ -37,5 +39,6 @@ This software is licensed under [Apache License, Version 2.0][license].
 [contributing]: https://github.com/censys/censys-cloud-connector/tree/main/CONTRIBUTING.md
 [gcp]: https://censys-cloud-connector.readthedocs.io/en/stable/providers.html#google-cloud-platform
 [github]: https://github.com/censys/censys-cloud-connector
+[github-issues]: https://github.com/censys/censys-cloud-connector/issues
 [license]: http://www.apache.org/licenses/LICENSE-2.0
 [supported-providers]: https://censys-cloud-connector.readthedocs.io/en/stable/providers.html
diff --git a/docs/_static/censys_favicon.ico b/docs/_static/censys_favicon.ico
diff --git a/docs/_static/censys_logo.png b/docs/_static/censys_logo.png
diff --git a/docs/_static/censys_logo_text.png b/docs/_static/censys_logo_text.png
diff --git a/docs/_static/censys_logo_text.svg b/docs/_static/censys_logo_text.svg
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,36 @@
+:root {
+    --censys-dark: #bd5b00;
+    --censys-light: #ffae62;
+    --censys-lighter: #ffebd7;
+    --censys-blue: #10069f;
+    --censys-light-blue: #9bbbfd;
+    --icon-success: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" aria-hidden="true"><path fill-rule="evenodd" d="M1.5 8a6.5 6.5 0 1113 0 6.5 6.5 0 01-13 0zM0 8a8 8 0 1116 0A8 8 0 010 8zm11.78-1.72a.75.75 0 00-1.06-1.06L6.75 9.19 5.28 7.72a.75.75 0 00-1.06 1.06l2 2a.75.75 0 001.06 0l4.5-4.5z"></path></svg>');
+}
+
+.admonition.censys {
+    border-color: var(--censys-blue);
+}
+.admonition.censys > .admonition-title {
+    background-color: var(--censys-light-blue);
+    border-color: var(--color-admonition-title--censys);
+}
+.admonition.censys > .admonition-title::before {
+    background-color: var(--censys-blue);
+    -webkit-mask-image: var(--icon-info);
+    mask-image: var(--icon-info);
+
+}
+
+.admonition.success {
+    border-color: var(--color-admonition-title--tip);
+}
+.admonition.success > .admonition-title {
+    background-color: var(--color-admonition-title-background--tip);
+    border-color: var(--color-admonition-title--tip);
+}
+.admonition.success > .admonition-title::before {
+    background-color: var(--color-admonition-title--tip);
+    -webkit-mask-image: var(--icon-success);
+    mask-image: var(--icon-success);
+
+}