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

Add CHANGELOG as vendored file #1239

Merged
merged 1 commit into from
Oct 28, 2023
Merged

Conversation

olleolleolle
Copy link
Member

@olleolleolle olleolleolle commented Oct 19, 2023

What was the end-user problem that led to this PR?

The problem was that a link to the CHANGELOG was 404ing. So, (in a now-closed PR) I made the link absolute, instead of relative, to work around the problem.

But, that'd take us to another website to look at Bundler's CHANGELOG. It'd be nice if Bundler's website knew about the CHANGELOG - had it locally.

What was your diagnosis of the problem?

My diagnosis was we didn't have all files that would be necessary to create a local CHANGELOG, we'd have to point outside this repo, to some on-GitHub data, not very nice. Not rendered in this nice way.

What is your fix for the problem, implemented in this PR?

Include CHANGELOG as a file in the generated site.

This fixes #1233.
This fixes #846

Why did you choose this fix out of the possible options?

I chose this fix because we mentioned it in #1233.

@deivid-rodriguez
Copy link
Member

I built a review app for this and the layout does not look good. I think you need to configure it here:

page "/conduct.html", layout: :two_column_layout
.

Also probably make it searchable here:

search.resources = ["index.html", "guides/", "#{config[:current_version]}/", "compatibility.html", "conduct.html", "contributors.html"]
.

- Searchable
- Using two_column_layout

See rubygems#1233
@deivid-rodriguez deivid-rodriguez temporarily deployed to bundler-site-add-ch-lrpv3eaqw1 October 28, 2023 07:58 Inactive
@olleolleolle
Copy link
Member Author

olleolleolle commented Oct 28, 2023

First: ✅ Now, with the two-column layout, much easier to read:
bild

Second: ✅ https://bundler-site-add-ch-lrpv3eaqw1.herokuapp.com/doc/contributing/bug_triage.html this page now links correctly to changelog.html

❓ I was not able to use the search box and hit anything in the changelog.html file. EDIT: I checked for the word "Pledge", which is in the Code of Conduct document, and this was also not findable. Reported as a separate Issue.

@olleolleolle olleolleolle merged commit a6df431 into rubygems:master Oct 28, 2023
3 checks passed
@olleolleolle olleolleolle deleted the add-ch branch October 28, 2023 08:22
@deivid-rodriguez
Copy link
Member

Amazing @olleolleolle, thanks so much!

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

Successfully merging this pull request may close these issues.

Include the CHANGELOG for the release 404: /changelog.html
2 participants