Moving Jenkins is the Way stories and case studies to jenkins.io

Thank you Thank you Thank you :slight_smile:

@dduportal , @hlemeur , and @smerle33, this is the public location of the discussions related to moving the Jenkins is the Way site content from https://jenkinsistheway.io to https://jenkinsistheway.jenkins.io .

@halkeye has converted the Wordpress site content into a site that we can manage as code. He recommends that we use Netlify to host the site through our open source project arrangement with Netlify. I assume we’ll need a DNS record created that points to the netlify site and we’ll need an SSL certificate for jenkinsistheway.jenkins.io

What other actions are needed in order to make this happen before the https://jenkinsistheway.io is closed in April?

One of the other threads mentioned GitHub pages. They have no infra cost so as long as one CI has support for doing GitHub push it’s pretty easy.

Otherwise I know infra.ci already has netlify, and I can set that up

Netlify sounds really good:

  • There are other sites such as status.jenkins.io in production with Netlify and/or using their preview feature in Pull requests, such as jenkins.io
  • Netlify is ready to be used in infra.ci as Gavin underlined
  • It’s free
  • It’s a way to nurture our relationship with them
  • Same as GH pages, but it adds the “preview” feature so good thing for authoring

It needs a tiny bit of cleanup (header is linked to plugins and i don’t know why, same with the cdf logo being blank). But generally its ready to move to jenkins-infra and hook up to ci

Key Changes:

  • Seperate repo
  • Netlify deploy and preview
  • Modern tooling (gatsby)
    • Images are being resized as needed and progessively loaded
  • MDX (Markdown with components)
    • Each user story has all of its images inside of its own directory, so easy to find resources that are used.

Future Improvements:

  • Netlify cms (Simple javascript insert that will allow people to create new entries via gui + github)
  • Prev / Next links at the top of user story links
  • Back to main page

That is a thing of beauty! Thanks.

The first line of text on the pages seems too close to the top bar in my browser. Looks like this on my screen at full width

screencapture-622d3b390deada177625a974-jenkins-is-the-way-netlify-app-user-story-to-happy-developers-2022-03-12-20_54_57-edit

Has more space between the top bar and the text in a narrower view:

screencapture-622d3b390deada177625a974-jenkins-is-the-way-netlify-app-user-story-to-happy-developers-2022-03-12-20_53_52-edit

My focus is to try and get it to a point more than just me can work on it, make tweaks. I’m not great at UI tweaks.

Totally open if anyone know what magic tricks jenkins.io uses to make things space right. Otherwise i’ll poke at it when I have a minute.

1 Like

as a final url, any preferences? I’m thinking with the theming.

Though probably easier to remember:

But open to ideas.

I like:

Might be worth considering

Some good/fun ideas there.

My vote goes for
1.- https://the.way.jenkins.io/
2.- https://jenkins.is.the.way.jenkins.io/

But mind you, I might be too conservative (or old…)

/- Jmm

strangely i don’t like https://jenkins.is.the.way.jenkins.io/ because it has too many jenkins, though I’m fine with https://jenkins-is-the-way.jenkins.io

I’m leaning towards way.jenkins.io and the.way.jenkins.io (one is easier to type)

i don’t have a strong opinion though, and its not really my project once i finish it

What about a name that does not necessarily has “Jenkins is the way” in the name?
https://stories.jenkins.io, for example.
It’s simple to read, easy to type, memorizable and sums up what “Jenkins is the way” is about; stories and case studies.

On the other hand, way.jenkins.io is as simple to type as my recommendation.

2 Likes

Seeing the discussion, I think the two best choices (my current preference)

  1. https://stories.jenkins.io/
  2. https://way.jenkins.io/

for the reasons outlined by @NotMyFault

+1 with Mark’s choices

okay, it’ll take me some time to do it, but i’m super happy with stories. I’ll try to get stories.jenkins.io working asap. Then i can finish polish.

Okay, so I spent the weekend trying to get netlify cms (clientside github flow cms thingie) working with stories. The main issue is the quote in the middle of the body, which i hacked a solution in the past, but coming to bite me now.

So as it stands right now, Content Manager (you have to use the netlify url for now until i get jenkins.io enabled for netlify). It works, we can call it done. Any edits on that link will create a PR to edit jenkins-is-the-way/index.mdx at d1c1b773611bae592d50c772a930fe7956f6f3d1 · jenkins-infra/jenkins-is-the-way · GitHub

Plan two though, is to finish making everything structured. As you can see from https://raw.githubusercontent.com/jenkins-infra/jenkins-is-the-way/d1c1b773611bae592d50c772a930fe7956f6f3d1/src/user-story/a-stable-projects-life/index.mdx its pretty yaml based right now, did that to make the formatting easier but I left the bottom parts free form markdown. So i’ve learned that its pretty easy to make yaml fields markdown parsed in gatsby, so I could make things like tag_line, organization and any other fields as markdown.

So @alyssat what do you say? Do you think the remaining data is structured enough that I can make things yaml? In the above example, I’m thinking of just making them “background”, “goals”, “solution_results”, and just keep going through the files and see if there’s any extra headers, etc.

I’m really liking the yaml idea, but I don’t know how hard it would be to manage. Does this make sense?

The way I see it, there are two sections + main title

Section 1 has subtitle, author, tag_line, and all the metadata
Section 2 has subtitle, background, goals, quote, solution & results, and a few more

Honestly the biggest barrier for me is to know either what the two sections should be called, or what the two sub titles can be called to seperated them.

Or i could just to title, subtitle, subsubtitle but that feels gross

Hi @halkeye - I think the yaml route is fine. I wouldn’t have idea wrt to managing either.

could it be called subtitle 1 and subtitle 2 ? :face_with_diagonal_mouth:
Or title, subtitle, and or use heading 1 - similar to the text options are given in google docs (?)

Been working on cleaning up the data more so it can be more manageable by netlify-cms

So apparently there’s 4 case studies that I was totally oblivious before, they should totally be handled differently.

d4science-amps-up-their-scientific-research-platform-with-ci-cd-powered-by-jenkins
jenkins-case-study-preply
jenkins-case-study-gainsight
jenkins-case-study-graylog

There are 3 map entries that don’t have a matching post. I’m just going to throw them away unless you can find the actual post they belong to (I tried matching the “name” but couldn’t come up with anything.

missing post_name jenkins-is-the-way-to-focus-on-your-code {
  map: {
    location: 'France',
    industries: [ 'Healthcare' ],
    name: 'Christophe Carpentier',
    latitude: '48.381438',
    longitude: '-4.620404'
  }
}
missing post_name to-pipeline-everything {
  map: {
    location: 'France',
    industries: [ 'Financial Services' ],
    name: 'Julien Schneider',
    latitude: '50.724993',
    longitude: '3.16207'
  }
}
missing post_name to-achieve-peace-of-mind {
  map: {
    location: 'United Kingdom',
    industries: [ 'Financial Services' ],
    name: 'Abhinav Chadha',
    latitude: '51.61028899999999',
    longitude: '-0.428278'
  }
}

Edit:
Okay, not all case studies are in the case study category

Skipping Case Study d4science-amps-up-their-scientific-research-platform-with-ci-cd-powered-by-jenkins
Skipping Case Study jenkins-case-study-preply
Skipping Case Study jenkins-case-study-gainsight
Skipping Case Study jenkins-case-study-graylog
Skipping Case Study tymit
Skipping Case Study jenkins-case-study-avoris-travel
Skipping Case Study topdanmark

This is more than i’d like to do by hand, so i’ll have to make another processor for those ones.