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

[Docs] Generate kamelets pages using Antora (main) #630

Merged
merged 7 commits into from Dec 24, 2021

Conversation

djencks
Copy link
Contributor

@djencks djencks commented Dec 15, 2021

Copy link
Contributor

@oscerd oscerd left a comment

Choose a reason for hiding this comment

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

This needs to take into account also the generator.go script. cc @nicolaferraro

@djencks
Copy link
Contributor Author

djencks commented Dec 16, 2021

Yes, at the moment both original and new versions of the kamelets pages are shown for easier comparison.
One difference is that I changed how the "required" status of a property is shown to match the other tables I've worked on: instead of a star after the name, the description starts with at bold "Required".

@nicolaferraro
Copy link
Member

Yes, at the moment both original and new versions of the kamelets pages are shown for easier comparison. One difference is that I changed how the "required" status of a property is shown to match the other tables I've worked on: instead of a star after the name, the description starts with at bold "Required".

Yes, the generator puts images into assets/images/kamelets, so I think this line needs to be changed:

dest := filepath.Join(out, "assets", "images", "kamelets", fmt.Sprintf("%s.svg", k.Name))

@djencks
Copy link
Contributor Author

djencks commented Dec 21, 2021 via email

@djencks djencks changed the title POC/WIP Main collect [Docs] Generate kamelets pages using Antora (main) Dec 21, 2021
@djencks
Copy link
Contributor Author

djencks commented Dec 21, 2021

This is ready to review.... would be nice to get it in before there are a lot more new kamelets :-)

@djencks djencks requested a review from oscerd December 21, 2021 22:18
@djencks
Copy link
Contributor Author

djencks commented Dec 21, 2021

The generator script only generates the nav file now, but it's still loading the entire yaml into a model because I can't figure out how the name gets into the model or how to get it on it's own.

Copy link
Contributor

@oscerd oscerd left a comment

Choose a reason for hiding this comment

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

I hope this won't break the projects using this stuff. I'll give a try to the PR locally and check.

@oscerd
Copy link
Contributor

oscerd commented Dec 21, 2021

LGTM at first sight btw

@djencks
Copy link
Contributor Author

djencks commented Dec 21, 2021

There was a problem with finding the images... not sure how my local builds worked... should be fixed now.

@djencks
Copy link
Contributor Author

djencks commented Dec 22, 2021

I think this PR will be OK but there's a bug in @djencks/asciidoctor-antora-indexer that prevents more than one set of components being generated properly in a full build. I'll let you know when it's fixed...

@oscerd
Copy link
Contributor

oscerd commented Dec 22, 2021

Ok, let's wait.

@djencks
Copy link
Contributor Author

djencks commented Dec 23, 2021

This is all fixed (all 3 branches) and the preview is at https://pr-735--camel.netlify.app/

@oscerd
Copy link
Contributor

oscerd commented Dec 23, 2021

Here

https://pr-735--camel.netlify.app/camel-kamelets/latest/

I'm getting

This file exists solely to defeat the limitations of the link checker, that is unaware of the .htaccess redirect from this page to the latest released version.

If you see this, you are not viewing the site through httpd or there is something wrong with the .htaccess file: in the latter case please let the camel developers know.

@djencks
Copy link
Contributor Author

djencks commented Dec 23, 2021 via email

@oscerd
Copy link
Contributor

oscerd commented Dec 23, 2021

LGTM.

@oscerd
Copy link
Contributor

oscerd commented Dec 23, 2021

Thanks

@djencks
Copy link
Contributor Author

djencks commented Dec 23, 2021

Is 'LGTM' the same as approval? I don't know what to do with the "changes requested" review since the code reviewed is gone.

@oscerd
Copy link
Contributor

oscerd commented Dec 24, 2021

yeah, I forgot to approve.

@djencks djencks merged commit f9b4657 into apache:main Dec 24, 2021
@djencks djencks deleted the main-collect branch December 24, 2021 17:09
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.

None yet

3 participants