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

a suggestion or improvement #294

Open
SophiaLi20 opened this issue Dec 25, 2024 · 2 comments
Open

a suggestion or improvement #294

SophiaLi20 opened this issue Dec 25, 2024 · 2 comments

Comments

@SophiaLi20
Copy link

SophiaLi20 commented Dec 25, 2024

In the src/configs/prod/apps.yaml we can add comments in different places for Improved Readability, Simplified Maintenance that helps in reducing the effort needed to debug or update the configuration as requirements evolve and Faster Onboarding so that new team members can quickly understand the purpose of the YAML file and how it is structured.

Example for this in code ;-

`# Notice section for employees to go paperless and verify mailing addresses
notice:
  label: 'City Employees - Go Paperless'  # Label for the notice
  pretext: ''
  text: 'Click the ESS tile to confirm that your mailing address is correct & to go paperless for your W2, ACA and paystubs. Tax documents will be available in January.'
# Applications section - Lists available apps grouped by categories
categories:
  - title: Applications  # Main category title
    show_request_access_link: false  # Hides request access link for this category
    icons: true  # Enables icons for apps in this category
    apps:
      - title: Beacon
        url: https://beacon.boston.gov/cob  # URL for the Beacon app
        icon: https://assets.boston.gov/icons/accessboston/lighthouse_basic_icon.svg  # Icon for Beacon app

      - title: Employee Self-Service
        url: https://ess.boston.gov/  # Link to the ESS portal
        icon: https://assets.boston.gov/icons/accessboston/ess.svg
        groups:
          - SG_AB_ESS  # Group with access to this app

if find suitable we can update the code

@PreritNag
Copy link

PreritNag commented Dec 27, 2024

hello , sir I am trying to improve apps.yaml file please review it sir
https://github.com/PreritNag/access-boston-config.git
steps to check

  1. go and click on above link
  2. click on Switch branches
  3. click on inhancement branch
  4. go to src then config then prod then apps.yaml . thank you @SophiaLi20

@SophiaLi20
Copy link
Author

sir @phillipbentonkelly can you please check the changes made by @PreritNag in the inhancement branch, as it has become more readable than before which will gonna help new developers and new team that will be going to work on this

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

No branches or pull requests

2 participants