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

Revise and restructure for the new web-page generator #10

Merged
merged 27 commits into from Oct 22, 2021

Conversation

mbreinhold
Copy link
Member

@mbreinhold mbreinhold commented Oct 22, 2021

Please review these changes to revise and restructure the amber-docs repository for use with the new web-page generator for openjdk.java.net.

That generator is presently defined in https://github.com/mbreinhold/ojweb-generate, which will shortly be moved over to the OpenJDK organization. Please see the README.md file in that repository for instructions on how to use it.

I’ve tried to keep content changes to a minimum, primarily adjusting minor things such as heading levels and code examples for better rendering.

You can preview the output here: https://openjdk.java.net/_test/amber/

For easy reviewing, there’s also a map of the entire subtree: https://openjdk.java.net/_test/amber/_map


Progress

  • Change must not contain extraneous whitespace

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/amber-docs pull/10/head:pull/10
$ git checkout pull/10

Update a local copy of the PR:
$ git checkout pull/10
$ git pull https://git.openjdk.java.net/amber-docs pull/10/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10

View PR using the GUI difftool:
$ git pr show -t 10

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/amber-docs/pull/10.diff

  - Raise `<h4>`s to `<h3>`s (`s/^#### /### /`)
  - Add `{.author}` to `<h4>`s listing authors and dates
  - Use `<br>` in multi-line author blocks
  - Adjust emphasis in a few places, using blockquotes and italics
  - Use `## Sub title {.subtitle}` for subtitles
  - Use unordered lists where appropriate
This change restores the JavaScript-driven highlighting of control
characters in this guide.  It also replaces the control characters
that do not exist in the Deja Vu fonts, namely

  - 2409 SYMBOL FOR HORIZONTAL TABULATION (␉)
  - 240D SYMBOL FOR CARRIAGE RETURN (␍)
  - 240A SYMBOL FOR LINE FEED (␊)

with corresponding arrow symbols that do exist in those fonts:

  - 21A6 RIGHTWARDS ARROW FROM BAR (↦)
  - 2190 LEFTWARDS ARROW (←)
  - 2193 DOWNWARDS ARROW (↓)
@bridgekeeper
Copy link

bridgekeeper bot commented Oct 22, 2021

👋 Welcome back mr! 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.

@mbreinhold mbreinhold changed the title Ojweb Revise and restructure for the new web-page generator Oct 22, 2021
@mbreinhold mbreinhold marked this pull request as ready for review October 22, 2021 16:11
@mbreinhold mbreinhold self-assigned this Oct 22, 2021
@openjdk
Copy link

openjdk bot commented Oct 22, 2021

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

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

Revise and restructure for the new web-page generator

Reviewed-by: briangoetz, jlaskey

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.

@mlbridge
Copy link

mlbridge bot commented Oct 22, 2021

Webrevs

@briangoetz briangoetz merged commit b1b1c46 into openjdk:master Oct 22, 2021
@openjdk openjdk bot mentioned this pull request Mar 10, 2022
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants