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

Actions to preview docs #511

Merged
merged 12 commits into from
Oct 23, 2023
Merged

Conversation

luanbrdev
Copy link
Contributor

Hey guys, how are you?

@gastaldi, @ricardozanini

Like we talk in conversation PR #493, I'm trying to add the actions to run the preview. But I don't know like test and I'm not sure if it's the correct way.

Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

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

I think the only thing we need to change is the website URL to not clash with Quarkus main.

@gastaldi
Copy link
Member

gastaldi commented Oct 4, 2023

I think we need to get to a common sense to have this feature for all Quarkiverse extensions. I have opened quarkusio/quarkus#36289 to investigate this.

@ricardozanini ricardozanini added area:documentation Improvements or additions to documentation DO NOT MERGE labels Oct 4, 2023
.github/workflows/preview.yml Outdated Show resolved Hide resolved
.github/workflows/preview.yml Outdated Show resolved Hide resolved
.github/workflows/preview_teardown.yml Outdated Show resolved Hide resolved
.github/workflows/preview.yml Show resolved Hide resolved
luanbrdev and others added 3 commits October 7, 2023 00:01
Co-authored-by: Ricardo Zanini <1538000+ricardozanini@users.noreply.github.com>
Co-authored-by: Ricardo Zanini <1538000+ricardozanini@users.noreply.github.com>
Co-authored-by: Ricardo Zanini <1538000+ricardozanini@users.noreply.github.com>
@luanbrdev luanbrdev marked this pull request as draft October 16, 2023 01:11
@luanbrdev luanbrdev marked this pull request as ready for review October 16, 2023 06:20
@ricardozanini
Copy link
Member

Sounds nice! Have you run it locally and were able to generate the website?

@luanbrdev
Copy link
Contributor Author

Hey @ricardozanini, how are you?
Well, when I run the project with mvn the index.html is generated correctly in /docs/target/generated-docs/.

About the actions, I could not run completely, what I did was, I executed the job "build" using (nektos/act) and added one step before Publishing directory for PR preview that printed all files in directory /docs/target/generated-docs/ and the index.html was generated. I think that it's working, but I could not run completely.

About jobs, preview and preview_teardown I only followed the example, but I not executed them.

Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

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

@gastaldi @hbelmiro wanna take a look, please?

@luanbrdev
Copy link
Contributor Author

Hi guys,
I understand. I already removed the unnecessary code.

@luanbrdev
Copy link
Contributor Author

Hi @ricardozanini, @gastaldi, @hbelmiro. How are you guys?
I would like to know if are there more adjusts to do? Let me know.

@ricardozanini
Copy link
Member

ricardozanini commented Oct 23, 2023

I'm merging this now, then you can rebase your other PR to see if we can get this preview going on!

@ricardozanini ricardozanini merged commit 66d8b42 into quarkiverse:main Oct 23, 2023
10 checks passed
hbelmiro added a commit that referenced this pull request Nov 10, 2023
@hbelmiro hbelmiro mentioned this pull request Nov 10, 2023
hbelmiro added a commit that referenced this pull request Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants