Merge pull request #20 from kitware-resonant/resonant-transition

Change verbage to reflect Resonant branding

Author: marySalvi

.github/workflows/doc.yml

@@ -18,13 +18,13 @@ jobs:
         run: |
           pip install -r requirements_doc.txt
       - name: Build Documentation
-        working-directory: doc
+        working-directory: resonant_docs
         run: make html
       - name: Stash build
         uses: actions/upload-artifact@v3
         with:
           name: doc-build
-          path: doc/build
+          path: resonant_docs/build
 
   deploy:
     name: Publish Documentation
@@ -36,10 +36,10 @@ jobs:
       - uses: actions/download-artifact@v3
         with:
           name: doc-build
-          path: doc/build
+          path: resonant_docs/build
       - name: Deploy to GH Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: doc/build/html
+          publish_dir: resonant_docs/build/html
           # cname: docs.girder.com

.gitignore

@@ -1,2 +1,2 @@
-doc/build
+resonant_docs/build
 .DS_Store

README.md

@@ -1,6 +1,6 @@
-# girder-4
+# resonant
 
-Girder 4 documentation materials.
+Resonant documentation materials.
 
 ## Build instructions
 

doc/source/_static/img/favicon.png

@@ -1,7 +1,7 @@
 [tool.poetry]
-name = "girder-4"
+name = "resonant_docs"
 version = "0.1.0"
-description = "Documentation for Girder"
+description = "Documentation for Resonant"
 authors = ["Kitware D&A Team <[email protected]>"]
 
 [tool.poetry.dependencies]

doc/source/_static/img/girder.png

@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Girder"
+project = "Resonant"
 copyright = "2022, Kitware, Inc."
 author = "Kitware, Inc."
 
@@ -62,7 +62,7 @@
 # a list of builtin themes.
 html_theme = "furo"
 
-html_logo = "_static/img/girder.png"
+html_logo = "_static/img/resonant.png"
 html_favicon = "_static/img/favicon.png"
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -71,18 +71,18 @@
 html_static_path = ["_static"]
 
 html_context = {
-    "github_user": "girder",
-    "github_repo": "girder-4",
-    "github_version": "main",
-    "doc_path": "doc",
+    "github_user": "resonant",
+    "github_repo": "resonant",
+    "github_version": "master",
+    "doc_path": "resonant_docs",
 }
 
 html_theme_options = {
     # "google_analytics_id": "",
     "footer_icons": [
         {
             "name": "GitHub",
-            "url": "https://github.com/girder",
+            "url": "https://github.com/kitware-resonant",
             "html": """
                 <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
                     <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>

doc/source/explanation/index.rst

@@ -0,0 +1,26 @@
+What is Resonant?
+=================
+
+.. toctree::
+   :hidden:
+
+   resonant
+
+
+**Resonant** is the Kitware Data and Analytics team’s newest framework, which we use to create rich web applications and APIs tailored to specific kinds of data and tasks. Girder, another framework created by the Data and Analytics team, used the CherryPy web server framework to present a monolithic platform upon which to build specific applications. Resonant marks a technology shift that enables us to build those applications more effectively: it is based instead upon Django, a more expansive web application framework with out-of-the-box support for many of the nuts and bolts of web application engineering. Django’s integrated support for domain models backed by a comprehensive object-relational mapping (ORM) means that Resonant projects place *domain-driven design* front and center, enabling our team to better understand and address the computing and data problems we take on, so we can deliver the right solution every time.
+
+Aside from a Django core, Resonant also includes several Kitware-engineered tools to specialize our work towards data-intensive applications, since our mission is to connect you with your data. These include
+
+* open source Django libraries for efficiently interacting with data stored in S3
+* a collection of turnkey configurations to set a whole slew of reasonable defaults for a new project
+* a Docker Compose based development environment that pulls together Django, PostgreSQL, * RabbitMQ (to broker messages for task handling via Celery), and MinIO (to provide a local implementation of the S3 storage protocol)
+
+There are also support materials for
+
+* creating a rich front end application for the project
+* spinning up templated codebases to get started rapidly
+* deploying to public cloud infrastructure
+* handling user authentication
+
+So, what is Resonant? Built on all these software pieces, you can think of it as a *methodology, including best practices and composable utilities, for building data-focused web applications using Django, Django REST Framework, PostgreSQL, and Celery.* This selection of libraries, configurations, and managed service offerings is the product of our team’s combined decades of web service development and maintenance experience. We wrote the libraries that are a part of Resonant to capture our evolving best practices and empower ourselves to work both *efficiently* and *effectively* on customer projects. The software is all open source, so it is free and available to use in your own projects. But remember that underneath the powerful parts we have contributed, Resonant projects are Django projects, and that we spend much of our thinking on understanding the domain and modeling it appropriately, so that the web applications we create enable our customers and collaborators to achieve deeper insight and power with their data.
+

pyproject.toml

@@ -1,19 +1,19 @@
-Girder 4
+Resonant
 ========
 
-Girder 4 is a set of best practices and composable utilities for building web
+Resonant is a set of best practices and composable utilities for building web
 applications with Django, Django Rest Framework (DRF), PostgreSQL, and Celery.
 
 
 Ecosystem
 ---------
 
-Functionality is broken into `many tagged repositories on GitHub <https://github.com/search?q=topic%3Agirder-4+org%3Agirder&type=Repositories>`_.
+Functionality is broken into `many tagged repositories on GitHub <https://github.com/orgs/kitware-resonant/repositories?`_.
 Each does one thing well and can generally be used on its own.
 
-* `django-s3-file-field <https://github.com/girder/django-s3-file-field>`_
-* `django-composed-configuration <https://github.com/girder/django-composed-configuration>`_
-* `django-auth-style <https://github.com/girder/django-auth-style>`_
+* `django-s3-file-field <https://github.com/kitware-resonant/django-s3-file-field>`_
+* `django-composed-configuration <https://github.com/kitware-resonant/django-composed-configuration>`_
+* `django-auth-style <https://github.com/kitware-resonant/django-auth-style>`_
 * `Vue project template <https://github.com/girder/vue-project-template>`_
 * `terraform-heroku-django <https://github.com/girder/terraform-heroku-django>`_
 * `django-large-image <https://github.com/girder/django-large-image>`_

doc/Makefile renamed to resonant_docs/Makefile

@@ -1,5 +1,5 @@
-Girder
-======
+Resonant
+========
 
 .. toctree::
    :caption: Contents
@@ -17,7 +17,7 @@ Girder
 
 
 
-*Girder* is the Kitware Data and Analytics team’s framework we use to create
+*Resonant* is the Kitware Data and Analytics team’s framework we use to create
 rich web applications and APIs tailored to specific kinds of data and tasks.