-
Notifications
You must be signed in to change notification settings - Fork 26
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
Split up the monolithic index.md, take two #82
Conversation
👋 Welcome back ihse! A progress list of the required criteria for merging this PR into |
Webrevs
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this Magnus! Looks good!
ALL_RESULT := $(patsubst src/%.md, build/dist/%.html, $(ALL_MD)) | ||
LEGACY_MD := $(wildcard src/*.md) | ||
LEGACY_FOOTER := $(patsubst src/%.md, build/support/footers/%.html, $(LEGACY_MD)) | ||
LEGACY_RESULT := $(patsubst src/%.md, build/dist/%.html, $(LEGACY_MD)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why legacy?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I dunno. I needed to call it something. :-) If you explain to me the purpose of codeReview.md
, jckAcquisition.md
,
reviewBodies.md
and webrevHelp.md
, I can give it a better name. My impression was that this was some old files that will be replaced by the guide in the fullness of time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, I replied in the other mail thread :-) Those files can be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll do that first, then.
@magicus This change now passes all automated pre-integration checks. After integration, the commit message for the final commit will be:
You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been no new commits pushed to the ➡️ To integrate this PR with the above commit message to the |
I'll push this change now. We can clean up the rest later, when the legacy files can be fully removed. |
/integrate |
Going to push as commit 6f2d441. |
Here's a resurrection of my old code to split up the monolithic index.md.
I have fully recreated the per-chapter files based on the current content of index.md. I have removed the number prefix and instead the order of the files are determined by
src/toc.conf
.By my quick inspection, the generated index.html looks identical to the one before.
I found some inconsistencies when doing this. For instance most, but not all, chapters end with a
footer. A reasonable follow-up is to move these per-chapter footers out of the actual markdown, and inject them when combining the file instead. This means less redundancy, and no more inconsistencies. ;-)
Progress
Reviewers
Reviewing
Using
git
Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/guide pull/82/head:pull/82
$ git checkout pull/82
Update a local copy of the PR:
$ git checkout pull/82
$ git pull https://git.openjdk.java.net/guide pull/82/head
Using Skara CLI tools
Checkout this PR locally:
$ git pr checkout 82
View PR using the GUI difftool:
$ git pr show -t 82
Using diff file
Download this PR as a diff file:
https://git.openjdk.java.net/guide/pull/82.diff