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

Documentation problem #222

Closed
Adriankhl opened this issue Jan 17, 2023 · 7 comments · Fixed by #223
Closed

Documentation problem #222

Adriankhl opened this issue Jan 17, 2023 · 7 comments · Fixed by #223
Labels
documentation Improvements or additions to documentation (not KDocs)
Milestone

Comments

@Adriankhl
Copy link
Contributor

The documentation website (https://kotlin.github.io/dataframe/overview.html) still shows version 0.8 and I think it should be updated.

I tried to do this myself (seems related to https://github.com/Kotlin/dataframe/blob/master/docs/StardustDocs/project.ihp) but I couldn't figure out how to generate the documentation. Running ./gradlew korro gives an error:

Could not apply requested plugin [id: 'io.github.devcrocod.korro', version: '0.1.1-dev-29'] as it does not provide a plugin with id 'io.github.devcrocod.korro'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s).
> Plugin with id 'io.github.devcrocod.korro' not found.
@pacher
Copy link
Contributor

pacher commented Jan 17, 2023

Same here. I tried googling stardust and stardustdocs with no result.
And I had to comment out korro in my local build because gradle could not find it.
Always wanted to ask about it on slack or so some day.

@koperagen
Copy link
Collaborator

koperagen commented Jan 17, 2023

Issue with korro is weirdly related to Gradle JVM. Build doesn't work with JDK 17 very well, so lowering Gradle JVM to 11 will make it work.
I think we need to just update gradle wrapper to newer versions to resolve it. Can you please try to update Gradle in gradle-wrapper.properties to newer versions and see if it resolves the issue for JDK 17?
As for documentation versions, i would have to ask my team :D I don't know how to update it. Now docs are built from md files in StartdustDocs/topics via our CI/CD. Korro is an utility to embed code snipets from tests into *.md files and isn't related to building website

@koperagen
Copy link
Collaborator

Ok, apparently updating version in that ihp file is how it should be done 4ff5d54. I'll have to deploy docs from CI after that

@Adriankhl
Copy link
Contributor Author

Updating gradle wrapper version does not help, and downgrading to JDK11 fixes the korro problem.

And I have created a PR to update the version number.

@koperagen
Copy link
Collaborator

Updating gradle wrapper version does not help, and downgrading to JDK11 fixes the korro problem.

And I have created a PR to update the version number.

Thank you! I'll create another issue about korro problem

@Jolanrensen Jolanrensen added this to the 0.10.0 milestone Jan 18, 2023
@Jolanrensen Jolanrensen added the documentation Improvements or additions to documentation (not KDocs) label Jan 18, 2023
@pacher
Copy link
Contributor

pacher commented Jan 23, 2023

@koperagen gentle reminder

to deploy docs from CI

This issue is closed, but the documentation website still shows version 0.8

Related #227

@Jolanrensen
Copy link
Collaborator

Looks like the publishing docs task was canceled somehow. Running it again :) Thanks for letting us know

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation (not KDocs)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants