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

Update dependencies for site documentation #1461

Merged
merged 4 commits into from
Mar 26, 2021

Conversation

bondolo
Copy link
Contributor

@bondolo bondolo commented Mar 26, 2021

Motivation:
The documentation produced for the servicetalk.io website uses plugins
and tools which have been updated. Where practical recent versions of
these dependencies should be used.

Modifications:
Plugins and tool dependencies used for generating and verifying the
servicetalk.io site are updated to current or more recent versions.

Result:
Updated versions are used for generating documentation

Motivation:
The documentation produced for the servicetalk.io website uses plugins
and tools which have been updated. Where practical recent versions of
these dependencies should be used.

Modifications:
Plugins and tool dependencies used for generating and verifying the
servicetalk.io site are updated to current/recent versions.

Result:
Current versions are used for generating documentation
@bondolo bondolo self-assigned this Mar 26, 2021
@bondolo
Copy link
Contributor Author

bondolo commented Mar 26, 2021

I was unable to update Antora to the latest version, 2.3.4, as the local site generated contains broken links. There appears to have been a change in how the site base URL is calculated beginning in 2.2.0.

@bondolo
Copy link
Contributor Author

bondolo commented Mar 26, 2021

I found the Antora 2.2.0 release notes which helped me figure out what needed to be changed so I was able to update to latest Antora, 2.3.4.

I compared the generated output of the current 2.0.0 version and the 2.3.4 and there is no significant difference obvious in the HTML, it has surprisingly few differences.

@@ -74,7 +73,8 @@ for (location in ["local", "remote"]) {

classpath = configurations.nuValidator
main = "nu.validator.client.SimpleCommandLineValidator"
args "--skip-non-html" // --also-check-css doesn't work (still checks css as html), so limit to html files
args "--also-check-css"
Copy link
Contributor

Choose a reason for hiding this comment

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

🚀

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just one of the many benefits of updating!

@tkountis
Copy link
Contributor

I was unable to update Antora to the latest version, 2.3.4, as the local site generated contains broken links. There appears to have been a change in how the site base URL is calculated beginning in 2.2.0.

Should we open a GH issue for that?

Copy link
Contributor

@tkountis tkountis left a comment

Choose a reason for hiding this comment

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

Checkstyle issue, then LGTM

@bondolo bondolo merged commit 4946440 into apple:main Mar 26, 2021
@idelpivnitskiy
Copy link
Member

Looks great! Thanks for taking care of it ❤️

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.

3 participants