sourcefuse / arc-docs Goto Github PK

The UI branch of ARC currently consists of the following modules:

React Boilerplate: https://github.com/sourcefuse/react-boilerplate-ts-ui
Angular Boilerplate: https://github.com/sourcefuse/angular-boilerplate
User onboarding library: Angular - React (as web component)
Search Library: Angular - React (as web component)
Workflows Creator Library: Angular - React (as web component)

We already have the individual pages for boilerplate but need an overview/Introduction page of ARC UI itself.

Add an article under the IAC Reference Architectures that describes

• How to roll out the security and billing alerts
• How to hook them up to common communication channels such as Opsgenie and Slack

We should include in this repo:

• pre-commit
• black
• flake8
• .editorconfig
• pyproject.toml
• etc

We can reference the followingarc-devops-infra for other Python code quality tools we have integrated for our repo.

add usage guide

1. The Map migrations page is not linked correctly and goes to a broken page.

• Navigate to https://sourcefuse.github.io/arc-docs/
• Expand ARC IaC
• Expand Reference Architectures
• Select MAP Migrations

2. The bullet lists are misaligned and need to be corrected.

Fixing the issue with Item # 1:

• Omit .md on this line: https://github.com/sourcefuse/arc-docs/blob/main/docs/arc-iac-docs/.pages.yml#L74

Todo:

• Add the initial hydration of files and .pages.yml changes in arc-docs repo. #27
• Add GitHub Action on all extension repos to automatically raise PRs here with the changes.
  • sourcefuse/loopback4-authentication@62f75d2
  • sourcefuse/loopback4-authorization#105
  • sourcefuse/loopback4-ratelimiter#132
  • sourcefuse/loopback4-s3#147
  • sourcefuse/loopback4-soft-delete#171
  • sourcefuse/loopback4-kafka-client#29
  • sourcefuse/loopback4-helmet#91
  • sourcefuse/loopback4-notifications#147
  • sourcefuse/loopback4-audit-log#84
  • sourcefuse/loopback4-vault#82

We need to include in the README how to push subpages to arc-docs from Terraform modules.

Please reference terraform-aws-arc-github-iam for the subpage layout (.docs/*) and how .github/workflows/docs/yaml is structured for pushes to this repo.

It should be included under this section

https://sourcefuse.github.io/arc-docs/arc-iac-docs/#reference-architectures

What

The task involves integrating Google Analytics into the ARC Docs site. This will enable tracking and analysis of user behavior, traffic patterns, and other relevant metrics for the documentation site. Google Analytics will provide valuable insights into how users interact with the ARC Docs, helping to improve content strategy and user experience.

Done When

• Google Analytics tracking code has been successfully added to all pages of the ARC Docs site.
• A Google Analytics property has been set up specifically for the ARC Docs site.
• Basic event tracking has been implemented for key user interactions (e.g., page views, document downloads, search queries).
• Custom dimensions and metrics have been set up to track ARC-specific data points, if applicable.
• Google Analytics data is being correctly collected and displayed in the Google Analytics dashboard.
• Access to the Google Analytics property has been granted to relevant team members.
• Documentation has been updated to include information about the Google Analytics implementation, including any custom tracking or events.
• A basic report or dashboard has been created to highlight key metrics for easy monitoring.
• The implementation has been tested across different browsers and devices to ensure proper tracking.

Could you please provide an explanation of autoscaling for ECS Fargate services and instructions on its usage?