Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lib Updates, Documentation Revisions, and Cleanup #519

Merged
merged 5 commits into from
Aug 20, 2024
Merged

Conversation

dividehex
Copy link
Contributor

    This update focuses on modernizing the frontend by updating
    outdated Node packages, removing deprecated dependencies, and
    refreshing the documentation. The existing Node packages were
    significantly outdated, leading to frequent dependabot-triggered
    pull requests. Additionally, some development-only packages that
    have long been abandoned were removed. The documentation, which
    was also outdated, has been revised.

    Here is a summary of the changes:
    * Removed Gulp (considering using Parcel in the future).
    * Removed Bower and migrated frontend package management
      to npm.
    * Added a JavaScript script to copy frontend packages to
      the static/lib directory.
    * Updated ESLint and converted the configuration to the new
      format.
    * Removed the start.sh Docker entry script in favor of calling
      Gunicorn directly.
    * Refactored the Dockerfile for better readability and pinned
      the Node.js version inside the Docker image.
    * Pinned all components to Node.js v18.20.4. This version is the
      latest minor/patch release in the v18 series and aligns with
      the version used in Auth0. When v20 or above becomes available
      in Auth0, we will update all IAM-related Node.js components
      accordingly.
    * Excluded external frontend dependencies from pre-commit linting.
    * Refactored tox.ini to reduce redundancy in tox environments.
    * Pinned the Node version in tox.
    * Overhauled the README.md.
    * Updated the dashboard screenshot with a more current image.
    * Overhauled the Mermaid diagram to reflect the current state
      of the SSO Dashboard infrastructure.

        This update focuses on modernizing the frontend by updating
        outdated Node packages, removing deprecated dependencies, and
        refreshing the documentation. The existing Node packages were
        significantly outdated, leading to frequent dependabot-triggered
        pull requests. Additionally, some development-only packages that
        have long been abandoned were removed. The documentation, which
        was also outdated, has been revised.

        Here is a summary of the changes:
        * Removed Gulp (considering using Parcel in the future).
        * Removed Bower and migrated frontend package management
          to npm.
        * Added a JavaScript script to copy frontend packages to
          the static/lib directory.
        * Updated ESLint and converted the configuration to the new
          format.
        * Removed the start.sh Docker entry script in favor of calling
          Gunicorn directly.
        * Refactored the Dockerfile for better readability and pinned
          the Node.js version inside the Docker image.
        * Pinned all components to Node.js v18.20.4. This version is the
          latest minor/patch release in the v18 series and aligns with
          the version used in Auth0. When v20 or above becomes available
          in Auth0, we will update all IAM-related Node.js components
          accordingly.
        * Excluded external frontend dependencies from pre-commit linting.
        * Refactored tox.ini to reduce redundancy in tox environments.
        * Pinned the Node version in tox.
        * Overhauled the README.md.
        * Updated the dashboard screenshot with a more current image.
        * Overhauled the Mermaid diagram to reflect the current state
          of the SSO Dashboard infrastructure.
@dividehex dividehex requested a review from a team August 20, 2024 17:26
Copy link
Contributor

@eduvic-mozilla eduvic-mozilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpicks, nothing to block approval

Dockerfile Outdated Show resolved Hide resolved
compose.yml Show resolved Hide resolved
dashboard/models/tile.py Outdated Show resolved Hide resolved
dashboard/models/tile.py Outdated Show resolved Hide resolved
@dividehex dividehex merged commit 5e9a920 into master Aug 20, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants