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

Split up the monolithic index.md, take two #82

Closed
wants to merge 4 commits into from

Conversation

magicus
Copy link
Member

@magicus magicus commented May 12, 2022

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

::: {.box}
[To the top](#){.boxheader}
:::

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

  • Change must not contain extraneous whitespace
  • Change must be properly reviewed (1 review required, with at least 1 reviewer)

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

Sorry, something went wrong.

@bridgekeeper
Copy link

bridgekeeper bot commented May 12, 2022

👋 Welcome back ihse! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr label May 12, 2022
@mlbridge
Copy link

mlbridge bot commented May 12, 2022

Webrevs

Copy link
Member

@JesperIRL JesperIRL left a 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))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why legacy?

Copy link
Member Author

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.

Copy link
Member

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.

Copy link
Member Author

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.

@openjdk
Copy link

openjdk bot commented May 12, 2022

@magicus This change now passes all automated pre-integration checks.

After integration, the commit message for the final commit will be:

Split up the monolithic index.md, take two

Reviewed-by: jwilhelm

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 master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready label May 12, 2022
@magicus magicus marked this pull request as draft May 12, 2022 19:45
@openjdk openjdk bot removed the rfr label May 12, 2022
@magicus magicus marked this pull request as ready for review May 12, 2022 20:50
@openjdk openjdk bot added the rfr label May 12, 2022
@magicus
Copy link
Member Author

magicus commented May 12, 2022

I'll push this change now. We can clean up the rest later, when the legacy files can be fully removed.

@magicus
Copy link
Member Author

magicus commented May 12, 2022

/integrate

@openjdk
Copy link

openjdk bot commented May 12, 2022

Going to push as commit 6f2d441.

@openjdk openjdk bot added the integrated label May 12, 2022
@openjdk openjdk bot closed this May 12, 2022
@openjdk
Copy link

openjdk bot commented May 12, 2022

@magicus Pushed as commit 6f2d441.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants