comcast / comcast.github.io

The main Open Source portal for Comcast

comcast.github.io

This is the main landing page for Open Source at Comcast. It highlights our efforts in the Free/Libre and Open Source Software movement.

Table of Contents

• License
• Code of Conduct
• Contributing
• Development Details
  • Code Quality
  • Accessibility
• Local development
  • Building
  • Deploying
• Documentation

License

Comcast.github.io is licensed under Apache License 2.0. Valid-License-Identifier: Apache-2.0

Code of Conduct

We take our code of conduct very seriously. Please abide by it.

Contributing

Please read our contributing guide for details on how to contribute to our project.

Development Details

This repository is a codebase built using React. Static pages are built for deployment using Next.js. Data is fetched from GitHub using the GraphQL on the GitHub GraphQL API . Node, NPM, and Webpack.

To separate concerns the components are in src/components, pages and layout files are contained in src/pages, and the content of the pages may be updated using the files in the src/data. This allows the content to be updated without needing to update the unit tests. Assets are contained in public as is standard practice for Next.js. Additional functions are in src/shared.

Code Quality

The code is linted during the pre-commit hook, and both linted and tested during the pre-push hook. Target code coverage for unit tests is 80%. Unit tests are written using Jest.

Accessibility

Submitted code should adhere to Web Content Accessibility Guidelines (WCAG).

Automated accessibility testing is built into the workflow:

• eslint-plugin-jsx-a11y provides code-level accessibility checking.
• react-axe provides non-prod accessibility testing in the console.
• jest-axe provides the ability to write unit tests for accessibility.

Manual testing should include, at the minimum, testing for keyboard operability, and reviewing the site using NVDA screen reader with the FireFox browser.

Development

After the codebase has been cloned and npm install has been run, npm run dev will create a webserver on the specified port for local development.

Building

npm run build generates the distribution files and exports them into the docs directory. It also creates a .nojekyll file to bypass Jekyll processing in Github Pages.

Deploying

npm run deploy

• runs the npm run build command (above)
• adds the newly created files to git staging
• creates a commit
• pushes those changes to the main branch

Documentation

The content of the pages may be updated using the files in the src/data directory or by updating the assets that are contained in the public directory. Full documentation for the pages, components, assets, and data sources can be found in the Wiki.

comcast.github.io's Issues

Update community section on main home page

Update core Project Page paragraph

"If you see a project that you would like to contribute to then go to our community page to learn how to get involved."

This is what is on the main page - it is a little bland. I think we need to make it more robust and attention grabbing

https://github.com/Comcast/comcast.github.io-website/blob/main/src/data/projects.json

backfill talks

References to Comcast NBCUniversal

We might want to drop the NBCUniversal part, and just go with Comcast, since NBCU has a different open sourcing process and space.

update humans.txt

comcast.github.io-website/public/humans.txt

Website project page - dead link

https://comcast.github.io/comcast.github.io-website/projects

https://comcast.github.io/comcast.github.io-websitehttps://github.com/Comcast - Link leads to a 404

Featured Projects section updates

Suggest the following updates to the Featured Projects section:

• remove (older) speedtestJS
• do Kuberhealthy and Trickster need to reference CNCF anywhere in the description?
• Bynar description references Kuberhealthy, need to update

Remove ¶ in home page paragraph

https://github.com/Comcast/comcast.github.io-website/blob/main/src/data/home.json

Remove smooth scrolling during keyboard navigation

The smooth scrolling behavior that occurs during keyboard navigation is jarring, particularly because elements on the page are large and spaced far apart. Can this be disabled?

Update stock image on people page

https://comcast.github.io/comcast.github.io-website/people - This image should be swapped out for something else

Link OpenSSF announcement to blog page

The OpenSSF announcement/article should be posted on the blog page under the “IN AND AROUND THE WEB” section here: https://comcast.github.io/blog

Date of article: May 9, 2022

Title: OpenSSF Announces 15 New Members To Further Strengthen Open Source Software Supply Chain Security

Link to article: https://openssf.org/press-release/2022/05/09/openssf-announces-15-new-members-to-further-strengthen-open-source-software-supply-chain-security/

Video for the COMMUNITY INVOLVEMENT section on the home page?

security vulnerabilities

fix potential security vulnerabilities in dependencies

Hacktoberfest 2020 link should be removed from main landing page

this page can stay so we can use it for the 2021 program: https://comcast.github.io/comcast.github.io-website/ \

but the link to it on the main page should be removed

update people page

add latest talk links like Shilla @ ASF, Shilla @ KubeCon EU
keynotes and topic talks can be merged into one category
talks should be sorted automatically by date
this is the page that needs to be updated: https://comcast.github.io/comcast.github.io-website/people

Backfill blog posts

update blog posts with past articles from 2016-2019

Updated blog page

Add latest blog entries from: https://comcast.github.io/blog.html
so that it shows up on this page: https://comcast.github.io/comcast.github.io-website/blog
and any other latest public/media press releases as they relate to open source

open source projects are not updating since July of 2022

t looks like open source projects are not loading on comcast.github.io since July of 2022. This is the page that is impacted: https://comcast.github.io/projects

Need to update link