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

krisstern · 2023-10-31T13:24:36Z

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 #3809 (comment)

The text was updated successfully, but these errors were encountered:

MarkEWaite · 2023-10-31T14:27:38Z

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 · 2023-10-31T14:45:14Z

@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 · 2023-10-31T14:54:58Z

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 · 2023-10-31T15:09:59Z

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 · 2023-10-31T16:16:14Z

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 · 2023-10-31T16:45:05Z

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 · 2023-10-31T16:54:02Z

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 · 2023-11-22T09:00:39Z

Action plan

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

lemeurherve · 2023-11-22T09:12:46Z

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

lemeurherve · 2023-11-22T09:26:10Z

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

krisstern · 2023-11-22T11:31:13Z

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 · 2023-11-22T12:22:09Z

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 · 2023-11-22T13:57:22Z

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 · 2023-11-22T13:58:19Z

I've renamed the repository contributor-spotlight.

lemeurherve · 2023-11-22T16:33:17Z

Update: CI part done 🎉

jenkins-infra/contributor-spotlight#15 (comment)

This PR creates a resource group and a storage account to store the static HTML content generated by jenkins-infra/contributor-spotlight#15 and which will be mounted as volume to be served on contributors.origin.jenkins.io from `publick8s` cluster. (contributors.jenkins.io will be served by the CDN Fastly) This content doesn't need to be accessible from elsewhere, hence the network protection. Ref: - jenkins-infra/helpdesk#3809 (comment)

This PR adds the File Share that will be used by the nginx-website release on publick8s cluster to serve on contributors.origin.jenkins.io the content generated in https://github.com/jenkins-infra/contributor-spotlight/. It also rename the storage account resource to be uniform. Follow-up of #523 Ref: - jenkins-infra/helpdesk#3809 (comment)

…re (#528) This PR recreates the storage account and the file share for contributors.jenkins.io The network rules deleted in a hotfix commit were still present when looking at the storage account in Azure Portal. I've deleted the (empty) storage account to recreate it with this PR. Other changes: - ZRS: no need for GRS, ZRS is sufficient - Type StorageV2: default value from the terraform provider, "Storage" (v1) is the legacy one, no cost change between them. - Add back network rules, allowing our IPs and the ones from publick8s and privatek8s vnets. Follow-up of: - #523 - #524 Ref: - jenkins-infra/helpdesk#3809 (comment)

This PR adds outputs to retrieve fine grained File Share SAS token so we can use azcopy instead of blobxfer and entire Storage Account access key. Ref: - jenkins-infra/helpdesk#3809 (comment)

lemeurherve · 2023-11-28T16:15:08Z

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

krisstern · 2023-11-30T14:42:56Z

Thanks @lemeurherve and team for making this happen!

kmartens27 · 2023-11-30T15:13:53Z

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

krisstern added the triage Incoming issues that need review label Oct 31, 2023

jenkins-infra-helpdesk-app bot added github jenkins.io labels Oct 31, 2023

lemeurherve self-assigned this Nov 2, 2023

lemeurherve removed the triage Incoming issues that need review label Nov 2, 2023

dduportal modified the milestones: infra-team-sync-2023-11-14, infra-team-sync-2023-11-21 Nov 7, 2023

dduportal modified the milestones: infra-team-sync-2023-11-21, infra-team-sync-2023-11-28 Nov 21, 2023

This was referenced Nov 22, 2023

npm run build fails with Error: ENOENT: no such file or directory, open 'src/images/jenkins.png' jenkins-infra/contributor-spotlight#12

Closed

feat: add contributors website CNAME records jenkins-infra/azure-net#173

Merged

lemeurherve mentioned this issue Nov 22, 2023

chore: update repository name to contributor-spotlight in README.md jenkins-infra/contributor-spotlight#14

Merged

This was referenced Nov 22, 2023

chore: add contributor-spotlight job to infra.ci.jenkins.io jenkins-infra/kubernetes-management#4704

Merged

feat(build): add a pipeline jenkins-infra/contributor-spotlight#15

Merged

This was referenced Nov 22, 2023

Plugin site builds failing on infra.ci #3816

Closed

feat: add nginx-website chart jenkins-infra/helm-charts#959

Merged

feat: add contributorsjenkinsio storage account jenkins-infra/azure#523

Merged

This was referenced Nov 23, 2023

feat(publick8s): add contributors.jenkins.io jenkins-infra/kubernetes-management#4710

Merged

feat(contributors.jenkins.io): add File Share jenkins-infra/azure#524

Merged

lemeurherve mentioned this issue Nov 28, 2023

chore(contributors.jenkins.io): add SAS token output jenkins-infra/azure#529

Merged

lemeurherve added the contributors.jenkins.io label Nov 28, 2023

This was referenced Nov 28, 2023

chore: add contributors.jenkins.io service in issue template #3836

Merged

feat: add azcopy jenkins-infra/docker-builder#182

Merged

lemeurherve closed this as completed Nov 28, 2023

lemeurherve modified the milestones: infra-team-sync-2023-11-28, infra-team-sync-2023-12-05 Nov 28, 2023

This was referenced Apr 2, 2024

chore: add azcopy updatecli manifest jenkins-infra/docker-builder#205

Merged

chore: fix azure-cli updatecli manifest jenkins-infra/docker-builder#206

Merged

lemeurherve mentioned this issue May 2, 2024

To host versioned jenkins.io docs on docs.jenkins.io #3885

Closed

lemeurherve mentioned this issue Jun 14, 2024

To host stats.jenkins.io GSoC 2024 project in jenkins-infra #4132

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

krisstern commented Oct 31, 2023 •

edited by lemeurherve

MarkEWaite commented Oct 31, 2023

kmartens27 commented Oct 31, 2023 •

edited

MarkEWaite commented Oct 31, 2023 •

edited

kmartens27 commented Oct 31, 2023

krisstern commented Oct 31, 2023

lemeurherve commented Oct 31, 2023 •

edited

lemeurherve commented Oct 31, 2023

lemeurherve commented Nov 22, 2023 •

edited

lemeurherve commented Nov 22, 2023

lemeurherve commented Nov 22, 2023 •

edited

krisstern commented Nov 22, 2023

MarkEWaite commented Nov 22, 2023 •

edited

kmartens27 commented Nov 22, 2023

lemeurherve commented Nov 22, 2023

lemeurherve commented Nov 22, 2023

lemeurherve commented Nov 28, 2023

krisstern commented Nov 30, 2023

kmartens27 commented Nov 30, 2023

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

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

Comments

krisstern commented Oct 31, 2023 • edited by lemeurherve

Service(s)

Summary

Reproduction steps

MarkEWaite commented Oct 31, 2023

kmartens27 commented Oct 31, 2023 • edited

MarkEWaite commented Oct 31, 2023 • edited

kmartens27 commented Oct 31, 2023

krisstern commented Oct 31, 2023

lemeurherve commented Oct 31, 2023 • edited

lemeurherve commented Oct 31, 2023

lemeurherve commented Nov 22, 2023 • edited

Action plan

lemeurherve commented Nov 22, 2023

lemeurherve commented Nov 22, 2023 • edited

krisstern commented Nov 22, 2023

MarkEWaite commented Nov 22, 2023 • edited

kmartens27 commented Nov 22, 2023

lemeurherve commented Nov 22, 2023

lemeurherve commented Nov 22, 2023

lemeurherve commented Nov 28, 2023

krisstern commented Nov 30, 2023

kmartens27 commented Nov 30, 2023

krisstern commented Oct 31, 2023 •

edited by lemeurherve

kmartens27 commented Oct 31, 2023 •

edited

MarkEWaite commented Oct 31, 2023 •

edited

lemeurherve commented Oct 31, 2023 •

edited

lemeurherve commented Nov 22, 2023 •

edited

lemeurherve commented Nov 22, 2023 •

edited

MarkEWaite commented Nov 22, 2023 •

edited