Skip to content

tools: update doc generator dependencies - #40042

Closed
targos wants to merge 1 commit into
nodejs:masterfrom
targos:tools-doc
Closed

tools: update doc generator dependencies#40042
targos wants to merge 1 commit into
nodejs:masterfrom
targos:tools-doc

Conversation

@targos

@targostargos commented Sep 8, 2021

Copy link
Copy Markdown
Member

This is not working yet. There are failing doctool tests and the generated files have issues.

/cc @aduh95@Trott

@targostargos added help wanted Issues that need assistance from volunteers or PRs that need help to proceed. wip Issues and PRs that are still a work in progress. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Sep 8, 2021
@nodejs-github-botnodejs-github-bot added the needs-ci PRs that need a full CI run. label Sep 8, 2021
@targostargos mentioned this pull request Sep 8, 2021
Closed
@targos

targos commented Sep 8, 2021•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Note that just updating remark-html like in #40033 doesn't help. The breaking change is exactly from remark-html 13.0.2.

@targos

targos commented Sep 8, 2021

Copy link
Copy Markdown
MemberAuthor

I just read the changelog: https://github.com/remarkjs/remark-html/releases/tag/13.0.2
It looks like we rely on the "unsafe" behavior.

@targos

targos commented Sep 8, 2021

Copy link
Copy Markdown
MemberAuthor

I opened #40043 to silence the dependabot alert while we work on this.

@aduh95

aduh95 commented Sep 8, 2021

Copy link
Copy Markdown
Contributor

generated files have issues.

Has this been resolved by #40043 or do you still need help? I've pulled the branch on my local repo and didn't find any obvious issue with the generated HTML.

@targos

targos commented Sep 9, 2021•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

No issues anymore, but many differences with the current version. I'd appreciate help to review these and compare the rendered pages visually

@Trott

Trott commented Sep 17, 2021

Copy link
Copy Markdown
Member

The .json files are different and I don't know enough about how they're used to be sure from a glance that it matters. I'll try to dig in, but if someone else does it before I do, I will not complain.

@Trott

Trott commented Sep 17, 2021

Copy link
Copy Markdown
Member

Looks to me like this is correct and the current version gets it wrong.

@Trott

Trott commented Sep 17, 2021

Copy link
Copy Markdown
Member

Before this PR, it adds in wrong <p> blocks in places like this:

image

With this PR, it's all one block:

image

@TrottTrott added request-ci Add this label to start a Jenkins CI on a PR. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed help wanted Issues that need assistance from volunteers or PRs that need help to proceed. labels Sep 17, 2021
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 17, 2021
@nodejs-github-bot

nodejs-github-bot commented Sep 17, 2021

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/39973/

@TrottTrott mentioned this pull request Sep 17, 2021
Closed
@Trott

This comment has been minimized.

Sign in to view
@Trott
Trott requested a review from aduh95September 17, 2021 13:49
@Trott

This comment has been minimized.

Sign in to view
@nodejs-github-bot

nodejs-github-bot commented Sep 17, 2021

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/39983/

@github-actionsgithub-actionsBot mentioned this pull request Sep 18, 2021
Open
17 tasks
@targostargos removed the wip Issues and PRs that are still a work in progress. label Sep 18, 2021
targos added a commit that referenced this pull request Sep 18, 2021
@targos
tools: update doc generator dependencies
2b080cb
PR-URL: #40042
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@targos

targos commented Sep 18, 2021

Copy link
Copy Markdown
MemberAuthor

Landed in 2b080cb

@targostargos closed this Sep 18, 2021
@targos
targos deleted the tools-doc branch September 18, 2021 14:33
@targostargos mentioned this pull request Sep 18, 2021
Closed
This was referenced Sep 19, 2021
Open
Open
BethGriggs pushed a commit that referenced this pull request Sep 21, 2021
@targos@BethGriggs
tools: update doc generator dependencies
c2fefb0
PR-URL: #40042
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
BethGriggs pushed a commit that referenced this pull request Sep 21, 2021
@targos@BethGriggs
tools: update doc generator dependencies
a8c99d9
PR-URL: #40042
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@BethGriggsBethGriggs mentioned this pull request Sep 21, 2021
Merged
1 task
This was referenced Sep 22, 2021
Open
Open
Open
Open
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@TrottTrottTrott approved these changes
@aduh95aduh95aduh95 approved these changes

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.needs-ciPRs that need a full CI run.toolsIssues and PRs related to the tools directory.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@targos@aduh95@Trott@nodejs-github-bot@jasnell