Start a new repo under jenkins-infra for the Jenkins Contributor Spotlight feature on jenkins.io

krisstern commented 1 year ago

Service(s)

GitHub, jenkins.io

Summary

We would like to host this Gatsby.js app for the Jenkins Contributor Spotlight feature with the URL https://contributors.jenkins.io/ (i.e. with contributors as the jenkins.io subdomain. A separate PR will be opened at https://github.com/jenkins-infra/jenkins-io-components to add this URL to the header formally in a later step.

Repo has been imported under jenkins-infra at https://github.com/jenkins-infra/jenkins-contributor-spotlight.

c.c. @kmartens27 @alyssat

Reproduction steps

N/A

EDIT @lemeurherve: detailled action plan at https://github.com/jenkins-infra/helpdesk/issues/3809#issuecomment-1822357561

MarkEWaite commented 1 year ago

Will this be in addition to the existing content on https://stories.jenkins.io/ ?

The current stories.jenkins.io page content is hosted at https://github.com/jenkins-infra/stories

kmartens27 commented 1 year ago

@MarkEWaite Would it make more sense to have it as an entity on jenkins.io, like how the blog exists and has its own content, or as a separate page/content section for stories.jenkins.io?

MarkEWaite commented 1 year ago

I like very much that the site is being generated with Gatsby and that it has its own design. That's aligned with the direction that @krisstern is leading with the versioned documentation project from Google Summer of Code.

I was curious if the current definition of stories.jenkins.io would be extended with the contributor stories or if there should be a new top level domain like https://contributors.jenkins.io

kmartens27 commented 1 year ago

I think there are positives to both options, but having it extend the definition of stories.jenkins.io would get more visitors to that and provide a gateway for users and readers to connect to the other stories. Having a separate domain could help with the "spotlight" feel/idea that we're going for when highlighting the contributors, but I'm not sure if there's something that could be an issue that I'm unaware of.

krisstern commented 1 year ago

I am wondering where is the code for the existing https://stories.jenkins.io/ hosted? Maybe I could take a look and see how easily I could integrate it to the contributor stories codebase? Or we could keep them separate to retain their different purposes?

Personally I prefer to have the two as separate features, since that way their differences can be kept as they appear to have two very distinct energies. But I am open to exploring different options.

lemeurherve commented 1 year ago

For the record, here is our last infra meeting notes after discussing with @kmartens47 and @MarkEWaite on the subject:

    * Does it "increment" stories.jenkins.io (`/contributors` for instance)? or does it a secondary website such as contributors.jenkins.io?
        * Already have a 2nd website with previe as per Kris work => secondary website looks easier
        * Proposal: link in stories.jenkins.io to redirect to the new website 
        * contributors.stories.jenkins.io / users.stories.jenkins.io
    * Hypothesis of "secondary website"
        * Need to fork the repo to jenkins-infra
            * WiP: Permission
        * TODO:
            * CI (preview website)
            * Production (same as stories.jenkins.io most probably)
            * CD (extend CI to production)

Going for a distinct website like contributors.jenkins.io seems easier for now, could be revised later.

I'll update this issue with a more detailed infra TODO plan.

lemeurherve commented 1 year ago

The https://github.com/orgs/jenkins-infra/teams/contributor-spotlight team including @krisstern @kmartens27 and @alyssat has been created and set as maintainer of https://github.com/jenkins-infra/jenkins-contributor-spotlight

lemeurherve commented 11 months ago

Action plan

[x] CI
- [x] Add job to ci.jenkins.io
- [x] https://ci.jenkins.io/job/Websites/ folder
- [x] Same job configuration as https://ci.jenkins.io/job/Websites/job/stories/
- [x] Add repository access to ci.jenkins.io GitHub app (App ID: 74951)
- [x] Add job to infra.ci.jenkins.io
- https://github.com/jenkins-infra/kubernetes-management/pull/4704
- [x] Create pipeline
- [x] Build/lint/test/typos check
  - [x] ESLint is already integrated to Gatsby: https://www.gatsbyjs.com/docs/how-to/custom-configuration/eslint/
- [x] Netlify preview on pull request
  - [x] Add site to jenkins-infra Netlify account
- https://github.com/jenkins-infra/contributor-spotlight/pull/15
- [x] Add status checks to repository branch protection
[x] Production
- [x] Host the service
- [x] Add a contributors.origin CNAME record to jenkins.io pointing to publick8s
  - https://github.com/jenkins-infra/azure-net/pull/173
- [x] Nginx based helm chart
  - https://github.com/jenkins-infra/helm-charts/pull/959
- [x] Storage account
  - https://github.com/jenkins-infra/azure/pull/523
  - No backup as the content is generated from the contributors repo
  - [x] File Share
  - 5Gio size, should be more than enought
  - https://github.com/jenkins-infra/azure/pull/524
  - https://github.com/jenkins-infra/azure/pull/528
- [x] Deployment on publick8s cluster
  - [x] Create secret in jenkins-infra/charts-secrets (private repo) with storage account credentials
  - [x] Create release
  - https://github.com/jenkins-infra/kubernetes-management/pull/4710
- [x] Setup Fastly cache
- [x] Add a contributors CNAME record to jenkins.io pointing to Fastly
  - https://github.com/jenkins-infra/azure-net/pull/173
- [x] Add to https://github.com/jenkins-infra/fastly/blob/main/services.tf
- [x] ~Add a CNAME record to jenkins.io for Fastly Let's encrypt SSL validation~ Fastly manages SSL certificate
[x] CD
- [x] Add deployment step to the pipeline (publication from infra.ci.jenkins.io)
- [x] Use azcopy and fine grained File Share SAS token instead of blobxfer and Storage Account access key
  - https://github.com/jenkins-infra/azure/pull/529
  - [x] Add event in Jenkins Infra shared calendar as reminder for updating File Share expiration date in two months
  - [x] Add credentials to infra.ci.jenkins.io
  - https://github.com/jenkins-infra/kubernetes-management/pull/4723
  - [x] Add azcopy to jenkins-infra/docker-builder
  - https://github.com/jenkins-infra/docker-builder/pull/182
- [x] Setup Matomo site
  - Site id 4, created by @halkeyes on https://jenkins-matomo.do.g4v.dev/ for the interim (thanks!)
- https://github.com/jenkins-infra/contributor-spotlight/pull/16
  - hotfix: https://github.com/jenkins-infra/contributor-spotlight/commit/7be95419a3ed69e5a2337741d42d068383f2840a
- [x] Add Datadog monitor
- https://github.com/jenkins-infra/datadog/pull/236
- [x] ~Add release-drafter~ no Docker image published, no release needed
- [x] Add Renovate
- [x] Add repository access to Renovate GitHub app
- [x] https://github.com/jenkins-infra/contributor-spotlight/pull/17 (onboarding PR opened by Renovate itself)
- [x] Pin Dependencies dashboard Renovate issue
  - https://github.com/jenkins-infra/contributor-spotlight/issues/20
- [x] Add a service and the corresponding label to jenkins-infra/helpdesk issue templates
- https://github.com/jenkins-infra/helpdesk/pull/3836
- [x] ???
- [x] Profit

lemeurherve commented 11 months ago

@jenkins-infra/contributor-spotlight I propose to rename the repository from "jenkins-contributor-spotlight" to "contributor-spotlight", WDYT?

lemeurherve commented 11 months ago

Also, what's the correct spelling of the project? "Contributors Spotlight" (plural like "stories") or "Contributor Spotlight"?

krisstern commented 11 months ago

I reckon we could use "Contributors Spotlight" instead, since that may be more apt as we will be spotlighting more than 1 contributor at any one time from the look of things. Sure, we could remove "jenkins" from the current GitHub repo name.

MarkEWaite commented 11 months ago

I reckon we could use "Contributors Spotlight" instead, since that may be more apt as we will be spotlighting more than 1 contributor at any one time from the look of things. Sure, we could remove "jenkins" from the current GitHub repo name.

I disagree. I think that a spotlight in this case is intended to shine on one person at a time. Some examples of the use of "Contributor Spotlight" include:

Mozilla - https://developer.mozilla.org/en-US/community/spotlight/tanner-dolby
Apache Beam - https://beam.apache.org/blog/contributor-spotlight-johanna-ojeling/
Split Rock Review - https://www.splitrockreview.org/news/category/Contributor+Spotlight
Making magazine - https://makingzine.com/blogs/news/contributor-spotlight-dawn-emily-clark
Localization lab - https://www.localizationlab.org/blog/2018/9/27/contributor-spotlight
Habitica - https://habitica.wordpress.com/category/contributor-spotlight/

When I initially searched for "Contributors Spotlight", Google search showed me "Contributor Spotlight" entries.

I like the removal of the redundant "jenkins-" prefix from the repository name. That matches with our patterns elsewhere of not placing "jenkins-" in the repository name.

kmartens27 commented 11 months ago

Just to echo what @MarkEWaite said, there will be a singular contributor spotlighted at a time. I also agree with removing the jenkins piece of the repo name as it is a bit redundant/out of line with the other repos.

lemeurherve commented 11 months ago

I've renamed the repository contributor-spotlight.

lemeurherve commented 11 months ago

Update: CI part done 🎉

https://github.com/jenkins-infra/contributor-spotlight/pull/15#issuecomment-1823099428

lemeurherve commented 11 months ago

Here we are, https://contributors.jenkins.io is alive!

krisstern commented 11 months ago

Thanks @lemeurherve and team for making this happen!

kmartens27 commented 11 months ago

Thank you so much @lemeurherve and everyone for making this possible

jenkins-infra / helpdesk